diff --git a/src/ResourceManager/AzureBatch/AzureRM.Batch.Netcore.psd1 b/src/ResourceManager/AzureBatch/AzureRM.Batch.Netcore.psd1 index 5eb2ad11c152..ce1b1b311431 100644 --- a/src/ResourceManager/AzureBatch/AzureRM.Batch.Netcore.psd1 +++ b/src/ResourceManager/AzureBatch/AzureRM.Batch.Netcore.psd1 @@ -107,8 +107,9 @@ CmdletsToExport = 'Remove-AzureRmBatchAccount', 'Get-AzureRmBatchAccount', 'New-AzureBatchComputeNodeUser', 'Remove-AzureBatchComputeNodeUser', 'Enable-AzureBatchTask', 'Set-AzureBatchTask', 'Stop-AzureBatchTask', 'Get-AzureBatchComputeNode', 'Get-AzureBatchJobSchedule', - 'New-AzureBatchJobSchedule', 'Remove-AzureBatchJobSchedule', - 'Get-AzureBatchTaskCounts' + 'New-AzureBatchJobSchedule', 'Remove-AzureBatchJobSchedule', + 'Get-AzureBatchTaskCounts', 'Get-AzureBatchPoolNodeCounts', + 'Start-AzureBatchComputeNodeServiceLogUpload' # Variables to export from this module # VariablesToExport = @() diff --git a/src/ResourceManager/AzureBatch/AzureRM.Batch.psd1 b/src/ResourceManager/AzureBatch/AzureRM.Batch.psd1 index 5cb3c8fe7200..50d518d4bc34 100644 --- a/src/ResourceManager/AzureBatch/AzureRM.Batch.psd1 +++ b/src/ResourceManager/AzureBatch/AzureRM.Batch.psd1 @@ -111,7 +111,8 @@ CmdletsToExport = 'Remove-AzureRmBatchAccount', 'Get-AzureRmBatchAccount', 'Enable-AzureBatchTask', 'Set-AzureBatchTask', 'Stop-AzureBatchTask', 'Get-AzureBatchComputeNode', 'Get-AzureBatchJobSchedule', 'New-AzureBatchJobSchedule', 'Remove-AzureBatchJobSchedule', - 'Get-AzureBatchTaskCounts' + 'Get-AzureBatchTaskCounts', 'Get-AzureBatchPoolNodeCounts', + 'Start-AzureBatchComputeNodeServiceLogUpload' # Variables to export from this module # VariablesToExport = @() diff --git a/src/ResourceManager/AzureBatch/BatchModelGenerator/Program.cs b/src/ResourceManager/AzureBatch/BatchModelGenerator/Program.cs index c0aa85eac1c2..08df18d509ab 100644 --- a/src/ResourceManager/AzureBatch/BatchModelGenerator/Program.cs +++ b/src/ResourceManager/AzureBatch/BatchModelGenerator/Program.cs @@ -84,6 +84,7 @@ public class Program {"Microsoft.Azure.Batch.NetworkConfiguration", "PSNetworkConfiguration"}, {"Microsoft.Azure.Batch.NetworkSecurityGroupRule", "PSNetworkSecurityGroupRule"}, {"Microsoft.Azure.Batch.NodeAgentSku", "PSNodeAgentSku"}, + {"Microsoft.Azure.Batch.NodeCounts", "PSNodeCounts"}, {"Microsoft.Azure.Batch.NodeFile", "PSNodeFile"}, {"Microsoft.Azure.Batch.OSDisk", "PSOSDisk"}, {"Microsoft.Azure.Batch.OutputFile", "PSOutputFile"}, @@ -92,6 +93,7 @@ public class Program {"Microsoft.Azure.Batch.OutputFileBlobContainerDestination", "PSOutputFileBlobContainerDestination"}, {"Microsoft.Azure.Batch.PoolEndpointConfiguration", "PSPoolEndpointConfiguration"}, {"Microsoft.Azure.Batch.PoolInformation", "PSPoolInformation"}, + {"Microsoft.Azure.Batch.PoolNodeCounts", "PSPoolNodeCounts"}, {"Microsoft.Azure.Batch.PoolSpecification", "PSPoolSpecification"}, {"Microsoft.Azure.Batch.PoolStatistics", "PSPoolStatistics"}, {"Microsoft.Azure.Batch.PoolUsageMetrics", "PSPoolUsageMetrics"}, @@ -114,6 +116,7 @@ public class Program {"Microsoft.Azure.Batch.TaskFailureInformation", "PSTaskFailureInformation"}, {"Microsoft.Azure.Batch.TaskSchedulingPolicy", "PSTaskSchedulingPolicy"}, {"Microsoft.Azure.Batch.TaskStatistics", "PSTaskStatistics"}, + {"Microsoft.Azure.Batch.UploadBatchServiceLogsResult", "PSStartComputeNodeServiceLogUploadResult"}, {"Microsoft.Azure.Batch.UsageStatistics", "PSUsageStatistics"}, {"Microsoft.Azure.Batch.UserAccount", "PSUserAccount"}, {"Microsoft.Azure.Batch.UserIdentity", "PSUserIdentity"}, diff --git a/src/ResourceManager/AzureBatch/ChangeLog.md b/src/ResourceManager/AzureBatch/ChangeLog.md index 6ad2ca781dac..184811472f51 100644 --- a/src/ResourceManager/AzureBatch/ChangeLog.md +++ b/src/ResourceManager/AzureBatch/ChangeLog.md @@ -18,6 +18,8 @@ - Additional information about change #1 --> ## Current Release +* Release new cmdlet Get-AzureBatchPoolNodeCounts +* Release new cmdlet Start-AzureBatchComputeNodeServiceLogUpload ## Version 4.0.7 * Set minimum dependency of module to PowerShell 5.0 diff --git a/src/ResourceManager/AzureBatch/Commands.Batch.Test/BatchTestHelpers.cs b/src/ResourceManager/AzureBatch/Commands.Batch.Test/BatchTestHelpers.cs index d235dd29b51a..4808abe57a07 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch.Test/BatchTestHelpers.cs +++ b/src/ResourceManager/AzureBatch/Commands.Batch.Test/BatchTestHelpers.cs @@ -712,6 +712,17 @@ public static AzureOperationResponse< return response; } + public static AzureOperationResponse, ProxyModels.AccountListPoolNodeCountsHeaders> CreatePoolNodeCountsGetResponse( + IEnumerable poolNodeCounts) + { + var response = new AzureOperationResponse, ProxyModels.AccountListPoolNodeCountsHeaders>(); + response.Response = new HttpResponseMessage(HttpStatusCode.OK); + + response.Body = new MockPagedEnumerable(poolNodeCounts); + + return response; + } + /// /// Builds a CloudTaskListResponse object /// @@ -980,6 +991,23 @@ public static CloudTask CreateFakeBoundTask(BatchAccountContext context) return context.BatchOMClient.JobOperations.GetTask("jobId", taskId, additionalBehaviors: new BatchClientBehavior[] { interceptor }); } + /// + /// Builds a ComputeNodeGetResponse object + /// + public static AzureOperationResponse CreateComputeNodeServiceLogsAddResponse(int numberOfFilesUploaded, string virtualDirectoryName) + { + var response = new AzureOperationResponse(); + response.Response = new HttpResponseMessage(HttpStatusCode.OK); + + ProxyModels.UploadBatchServiceLogsResult result = new ProxyModels.UploadBatchServiceLogsResult(); + result.NumberOfFilesUploaded = numberOfFilesUploaded; + result.VirtualDirectoryName = virtualDirectoryName; + + response.Body = result; + + return response; + } + /// /// Uses Reflection to set a property value on an object. Can be used to bypass restricted set accessors. /// diff --git a/src/ResourceManager/AzureBatch/Commands.Batch.Test/Commands.Batch.Test.csproj b/src/ResourceManager/AzureBatch/Commands.Batch.Test/Commands.Batch.Test.csproj index 2969d8620573..578658cd75d1 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch.Test/Commands.Batch.Test.csproj +++ b/src/ResourceManager/AzureBatch/Commands.Batch.Test/Commands.Batch.Test.csproj @@ -45,7 +45,7 @@ ..\..\..\packages\Hyak.Common.1.0.3\lib\portable-net403+win+wpa81\Hyak.Common.dll - ..\..\..\packages\Azure.Batch.8.0.0\lib\net452\Microsoft.Azure.Batch.dll + ..\..\..\packages\Azure.Batch.8.1.1\lib\net452\Microsoft.Azure.Batch.dll ..\..\..\packages\Microsoft.Azure.Common.2.1.0\lib\net45\Microsoft.Azure.Common.dll @@ -93,14 +93,14 @@ False ..\..\..\packages\Microsoft.IdentityModel.Clients.ActiveDirectory.2.28.3\lib\net45\Microsoft.IdentityModel.Clients.ActiveDirectory.dll + + ..\..\..\packages\Microsoft.Rest.ClientRuntime.Azure.Authentication.2.2.9-preview\lib\net45\Microsoft.Rest.ClientRuntime.Azure.Authentication.dll + True + False ..\..\..\packages\Microsoft.IdentityModel.Clients.ActiveDirectory.2.28.3\lib\net45\Microsoft.IdentityModel.Clients.ActiveDirectory.WindowsForms.dll - - ..\..\..\packages\Microsoft.Rest.ClientRuntime.Azure.Authentication.2.2.9-preview\lib\net45\Microsoft.Rest.ClientRuntime.Azure.Authentication.dll - True - ..\..\..\packages\Microsoft.Rest.ClientRuntime.Azure.TestFramework.1.5.0-preview\lib\net45\Microsoft.Rest.ClientRuntime.Azure.TestFramework.dll True @@ -186,6 +186,7 @@ + @@ -212,6 +213,7 @@ + diff --git a/src/ResourceManager/AzureBatch/Commands.Batch.Test/ComputeNodes/StartBatchComputeNodeServiceLogUploadCommandTests.cs b/src/ResourceManager/AzureBatch/Commands.Batch.Test/ComputeNodes/StartBatchComputeNodeServiceLogUploadCommandTests.cs new file mode 100644 index 000000000000..0d9153e3757d --- /dev/null +++ b/src/ResourceManager/AzureBatch/Commands.Batch.Test/ComputeNodes/StartBatchComputeNodeServiceLogUploadCommandTests.cs @@ -0,0 +1,151 @@ +// ---------------------------------------------------------------------------------- +// +// Copyright Microsoft Corporation +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// http://www.apache.org/licenses/LICENSE-2.0 +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// ---------------------------------------------------------------------------------- + +using Microsoft.Azure.Batch; +using Microsoft.Azure.Batch.Protocol; +using Microsoft.Azure.Commands.Batch.Models; +using Microsoft.Rest.Azure; +using Microsoft.WindowsAzure.Commands.ScenarioTest; +using Moq; +using System; +using System.Collections.Generic; +using System.Management.Automation; +using Xunit; +using BatchClient = Microsoft.Azure.Commands.Batch.Models.BatchClient; +using ProxyModels = Microsoft.Azure.Batch.Protocol.Models; + +namespace Microsoft.Azure.Commands.Batch.Test.ComputeNodes +{ + public class StartBatchComputeNodeServiceLogUploadCommandTests : WindowsAzure.Commands.Test.Utilities.Common.RMTestBase + { + private StartBatchComputeNodeServiceLogUploadCommand startComputeNodeServiceLogUploadCommand; + private GetBatchComputeNodeCommand getComputeNodeCommand; + private Mock batchClientMock; + private Mock commandRuntimeMock; + private const string fakeUrl = "https://containerUrl?sv=="; + + public StartBatchComputeNodeServiceLogUploadCommandTests(Xunit.Abstractions.ITestOutputHelper output) + { + ServiceManagemenet.Common.Models.XunitTracingInterceptor.AddToContext(new ServiceManagemenet.Common.Models.XunitTracingInterceptor(output)); + batchClientMock = new Mock(); + commandRuntimeMock = new Mock(); + + getComputeNodeCommand = new GetBatchComputeNodeCommand() + { + CommandRuntime = commandRuntimeMock.Object, + BatchClient = batchClientMock.Object, + }; + + startComputeNodeServiceLogUploadCommand = new StartBatchComputeNodeServiceLogUploadCommand() + { + CommandRuntime = commandRuntimeMock.Object, + BatchClient = batchClientMock.Object, + }; + } + + [Fact] + [Trait(Category.AcceptanceType, Category.CheckIn)] + public void WhenStartBatchComputeNodeServiceLogUploadCommandIsCalledWithPoolIdAndComputeNodeId_ShouldSucceed() + { + // Setup cmdlet to get a compute node by id + BatchAccountContext context = BatchTestHelpers.CreateBatchContextWithKeys(); + startComputeNodeServiceLogUploadCommand.BatchContext = context; + startComputeNodeServiceLogUploadCommand.PoolId = "pool"; + startComputeNodeServiceLogUploadCommand.ComputeNodeId = "tvm"; + startComputeNodeServiceLogUploadCommand.ContainerUrl = fakeUrl; + startComputeNodeServiceLogUploadCommand.StartTime = DateTime.UtcNow; + + const int numberOfFilesUploaded = 2; + const string virtualDirectoryName = "pool1/tvm"; + + // Build a compute node instead of querying the service on a Get ComputeNode call + AzureOperationResponse response = + BatchTestHelpers.CreateComputeNodeServiceLogsAddResponse(numberOfFilesUploaded, virtualDirectoryName); + + RequestInterceptor interceptor = BatchTestHelpers.CreateFakeServiceResponseInterceptor< + ProxyModels.ComputeNodeUploadBatchServiceLogsOptions, + AzureOperationResponse>(response); + + startComputeNodeServiceLogUploadCommand.AdditionalBehaviors = new List() { interceptor }; + + // Setup the cmdlet to write pipeline output to a list that can be examined later + PSStartComputeNodeServiceLogUploadResult result = null; + commandRuntimeMock.Setup(r => r.WriteObject(It.IsAny())).Callback(c => result = (PSStartComputeNodeServiceLogUploadResult)c); + + startComputeNodeServiceLogUploadCommand.ExecuteCmdlet(); + + Assert.NotNull(result); + Assert.Equal(result.NumberOfFilesUploaded, numberOfFilesUploaded); + Assert.Equal(result.VirtualDirectoryName, virtualDirectoryName); + } + + [Fact] + [Trait(Category.AcceptanceType, Category.CheckIn)] + public void WhenStartBatchComputeNodeServiceLogUploadCommandIsCalledWithComputeNode_ShouldSucceed() + { + // First get a fake tvm + BatchAccountContext context = BatchTestHelpers.CreateBatchContextWithKeys(); + getComputeNodeCommand.BatchContext = context; + getComputeNodeCommand.PoolId = "Pool1"; + getComputeNodeCommand.Id = null; + getComputeNodeCommand.Filter = null; + + AzureOperationResponse, ProxyModels.ComputeNodeListHeaders> response1 = + BatchTestHelpers.CreateComputeNodeListResponse(new[] { "tvm1" }); + + RequestInterceptor interceptor1 = BatchTestHelpers.CreateFakeServiceResponseInterceptor< + ProxyModels.ComputeNodeListOptions, + AzureOperationResponse, ProxyModels.ComputeNodeListHeaders>>(response1); + + var computeNodes = new List(); + commandRuntimeMock.Setup(r => r.WriteObject(It.IsAny())) + .Callback(c => computeNodes.Add((PSComputeNode) c)); + + getComputeNodeCommand.AdditionalBehaviors = new List() { interceptor1 }; + + getComputeNodeCommand.ExecuteCmdlet(); + + // test StartBatchComputeNodeServiceLogUploadCommand + startComputeNodeServiceLogUploadCommand.BatchContext = context; + startComputeNodeServiceLogUploadCommand.ComputeNode = computeNodes[0]; + startComputeNodeServiceLogUploadCommand.ContainerUrl = fakeUrl; + + var utcNow = DateTime.UtcNow; + startComputeNodeServiceLogUploadCommand.StartTime = utcNow.AddDays(-1); + startComputeNodeServiceLogUploadCommand.EndTime = utcNow; + + const int numberOfFilesUploaded = 2; + const string virtualDirectoryName = "pool1/tvm"; + + AzureOperationResponse response2 = + BatchTestHelpers.CreateComputeNodeServiceLogsAddResponse(numberOfFilesUploaded, virtualDirectoryName); + + RequestInterceptor interceptor2 = BatchTestHelpers.CreateFakeServiceResponseInterceptor< + ProxyModels.ComputeNodeUploadBatchServiceLogsOptions, + AzureOperationResponse>(response2); + + startComputeNodeServiceLogUploadCommand.AdditionalBehaviors = new List() { interceptor2 }; + + // Setup the cmdlet to write pipeline output to a list that can be examined later + PSStartComputeNodeServiceLogUploadResult result = null; + commandRuntimeMock.Setup(r => r.WriteObject(It.IsAny())).Callback(c => result = (PSStartComputeNodeServiceLogUploadResult)c); + + startComputeNodeServiceLogUploadCommand.ExecuteCmdlet(); + + Assert.NotNull(result); + Assert.Equal(result.NumberOfFilesUploaded, numberOfFilesUploaded); + Assert.Equal(result.VirtualDirectoryName, virtualDirectoryName); + } + } +} diff --git a/src/ResourceManager/AzureBatch/Commands.Batch.Test/Pools/GetBatchPoolNodeCountsCommandTests.cs b/src/ResourceManager/AzureBatch/Commands.Batch.Test/Pools/GetBatchPoolNodeCountsCommandTests.cs new file mode 100644 index 000000000000..9e246552f209 --- /dev/null +++ b/src/ResourceManager/AzureBatch/Commands.Batch.Test/Pools/GetBatchPoolNodeCountsCommandTests.cs @@ -0,0 +1,359 @@ +// ---------------------------------------------------------------------------------- +// +// Copyright Microsoft Corporation +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// http://www.apache.org/licenses/LICENSE-2.0 +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// ---------------------------------------------------------------------------------- + +using Microsoft.Azure.Batch; +using Microsoft.Azure.Batch.Protocol; +using Microsoft.Azure.Commands.Batch.Models; +using Microsoft.Rest.Azure; +using Microsoft.WindowsAzure.Commands.ScenarioTest; +using Moq; +using System; +using System.Collections; +using System.Collections.Generic; +using System.Linq; +using System.Management.Automation; +using System.Reflection; +using System.Threading.Tasks; +using Xunit; +using BatchClient = Microsoft.Azure.Commands.Batch.Models.BatchClient; +using ProxyModels = Microsoft.Azure.Batch.Protocol.Models; + +namespace Microsoft.Azure.Commands.Batch.Test.Pools +{ + public class GetBatchPoolNodeCountsCommandTests : WindowsAzure.Commands.Test.Utilities.Common.RMTestBase + { + private GetBatchPoolNodeCountsCommand cmdlet; + private Mock batchClientMock; + private Mock commandRuntimeMock; + + public GetBatchPoolNodeCountsCommandTests(Xunit.Abstractions.ITestOutputHelper output) + { + ServiceManagemenet.Common.Models.XunitTracingInterceptor.AddToContext( + new ServiceManagemenet.Common.Models.XunitTracingInterceptor(output)); + batchClientMock = new Mock(); + commandRuntimeMock = new Mock(); + cmdlet = new GetBatchPoolNodeCountsCommand() + { + CommandRuntime = commandRuntimeMock.Object, + BatchClient = batchClientMock.Object, + }; + } + + [Fact] + [Trait(Category.AcceptanceType, Category.CheckIn)] + public void WhenGetBatchPoolNodeCountsCommandIsCalledWithoutFilter_ShouldReturnAllPools() + { + // Setup cmdlet to get a pool by id + BatchAccountContext context = BatchTestHelpers.CreateBatchContextWithKeys(); + cmdlet.BatchContext = context; + var poolNodeCounts1 = new ProxyModels.PoolNodeCounts() + { + PoolId = "Pool1", + Dedicated = new ProxyModels.NodeCounts( + creating: 1, + idle: 2, + offline: 3, + preempted: 4, + rebooting: 5, + reimaging: 6, + running: 7, + starting: 8, + startTaskFailed: 9, + leavingPool: 10, + unknown: 11, + unusable: 12, + waitingForStartTask: 13, + total: 91), // Total + LowPriority = new ProxyModels.NodeCounts( + creating: 1, + idle: 2, + offline: 3, + preempted: 4, + rebooting: 5, + reimaging: 6, + running: 7, + starting: 8, + startTaskFailed: 9, + leavingPool: 10, + unknown: 11, + unusable: 12, + waitingForStartTask: 13, + total: 91), // Total + }; + + var poolNodeCounts2 = new ProxyModels.PoolNodeCounts() + { + PoolId = "Pool2", + Dedicated = new ProxyModels.NodeCounts( + creating: 11, + idle: 12, + offline: 13, + preempted: 14, + rebooting: 15, + reimaging: 16, + running: 17, + starting: 18, + startTaskFailed: 19, + leavingPool: 20, + unknown: 21, + unusable: 22, + waitingForStartTask: 23, + total: 221), // Total + LowPriority = new ProxyModels.NodeCounts( + creating: 11, + idle: 12, + offline: 13, + preempted: 14, + rebooting: 15, + reimaging: 16, + running: 17, + starting: 18, + startTaskFailed: 19, + leavingPool: 20, + unknown: 21, + unusable: 22, + waitingForStartTask: 23, + total: 221), // Total + }; + + // Simulate node state counts for two pools are returned + var poolsNodeCounts = new List() + { + poolNodeCounts1, + poolNodeCounts2 + }; + + // Build a PoolNodeCounts instead of querying the service on a Get PoolNodeCounts call + AzureOperationResponse, ProxyModels.AccountListPoolNodeCountsHeaders> response = + BatchTestHelpers.CreatePoolNodeCountsGetResponse(poolsNodeCounts); + RequestInterceptor interceptor = BatchTestHelpers.CreateFakeServiceResponseInterceptor< + ProxyModels.AccountListPoolNodeCountsOptions, + AzureOperationResponse, ProxyModels.AccountListPoolNodeCountsHeaders>>(response); + + cmdlet.AdditionalBehaviors = new List() { interceptor }; + + List psPoolsNodeCounts = new List(); + commandRuntimeMock.Setup(r => + r.WriteObject(It.IsAny())) + .Callback(p => psPoolsNodeCounts.Add((PSPoolNodeCounts)p)); + + cmdlet.ExecuteCmdlet(); + + var psPoolNodeCounts1 = psPoolsNodeCounts.FirstOrDefault(c => c.PoolId == "Pool1"); + + var psPoolNodeCounts2 = psPoolsNodeCounts.FirstOrDefault(c => c.PoolId == "Pool2"); + + Assert.NotNull(psPoolNodeCounts1); + Assert.NotNull(psPoolNodeCounts2); + + var comparer = new PoolNodeCountsObjectComparer(); + + Assert.True(comparer.AreEqual(poolNodeCounts1, psPoolNodeCounts1)); + Assert.True(comparer.AreEqual(poolNodeCounts2, psPoolNodeCounts2)); + } + + [Fact] + [Trait(Category.AcceptanceType, Category.CheckIn)] + public void WhenGetBatchPoolNodeCountsCommandIsCalledWithPoolIdOption_ShouldHonorPoolIdFilter() + { + const string poolId = "Pool1"; + // Setup cmdlet to list pools using an OData filter + BatchAccountContext context = BatchTestHelpers.CreateBatchContextWithKeys(); + cmdlet.BatchContext = context; + cmdlet.PoolId = poolId; + + string requestFilter = null; + + AzureOperationResponse, ProxyModels.AccountListPoolNodeCountsHeaders> fakeResponse = + BatchTestHelpers.CreateGenericAzureOperationListResponse(); + + Action, ProxyModels.AccountListPoolNodeCountsHeaders>>> requestAction = + (request) => + { + ProxyModels.AccountListPoolNodeCountsOptions options = request.Options; + requestFilter = options.Filter; + }; + + RequestInterceptor requestInterceptor = BatchTestHelpers.CreateFakeServiceResponseInterceptor( + responseToUse: fakeResponse, requestAction: requestAction); + + cmdlet.AdditionalBehaviors = new List() { requestInterceptor }; + + cmdlet.ExecuteCmdlet(); + + Assert.Equal(requestFilter, $"(poolId eq '{poolId}')"); + } + + [Fact] + [Trait(Category.AcceptanceType, Category.CheckIn)] + public void WhenGetBatchPoolNodeCountsCommandIsCalledWithCloudPoolOption_ShouldHonorPoolFilter() + { + // Setup cmdlet to list pools using an OData filter + BatchAccountContext context = BatchTestHelpers.CreateBatchContextWithKeys(); + + PSCloudPool fakeCloudPool = new PSCloudPool(BatchTestHelpers.CreateFakeBoundPool(context)); + cmdlet.BatchContext = context; + cmdlet.Pool = fakeCloudPool; + + string requestFilter = null; + + AzureOperationResponse, ProxyModels.AccountListPoolNodeCountsHeaders> fakeResponse = + BatchTestHelpers.CreateGenericAzureOperationListResponse(); + + Action, ProxyModels.AccountListPoolNodeCountsHeaders>>> requestAction = + (request) => + { + ProxyModels.AccountListPoolNodeCountsOptions options = request.Options; + requestFilter = options.Filter; + }; + + RequestInterceptor requestInterceptor = BatchTestHelpers.CreateFakeServiceResponseInterceptor( + responseToUse: fakeResponse, requestAction: requestAction); + + cmdlet.AdditionalBehaviors = new List() { requestInterceptor }; + + cmdlet.ExecuteCmdlet(); + + Assert.Equal(requestFilter, $"(poolId eq '{fakeCloudPool.Id}')"); + } + + [Fact] + [Trait(Category.AcceptanceType, Category.CheckIn)] + public void WhenPSNodeCountsFormatObjectIsCalled_ShouldSerlializeNodeCountsToString() + { + const int creating = 1; + const int idle = 2; + const int offline = 3; + const int preempted = 4; + const int rebooting = 5; + const int reimaging = 6; + const int running = 7; + const int starting = 8; + const int startTaskFailed = 9; + const int leavingPool = 10; + const int unknown = 11; + const int unusable = 12; + const int waitingForStartTask = 13; + const int total = 91; + + var poolNodeCounts = new ProxyModels.PoolNodeCounts() + { + PoolId = "Pool1", + // all non-zero properties + Dedicated = new ProxyModels.NodeCounts( + creating: creating, + idle: idle, + offline: offline, + preempted: preempted, + rebooting: rebooting, + reimaging: reimaging, + running: running, + starting: starting, + startTaskFailed: startTaskFailed, + leavingPool: leavingPool, + unknown: unknown, + unusable: unusable, + waitingForStartTask: waitingForStartTask, + total: total), // Total + // all zero properties + LowPriority = new ProxyModels.NodeCounts( + creating: 0, + idle: 0, + offline: 0, + preempted: 0, + rebooting: 0, + reimaging: 0, + running: 0, + starting: 0, + startTaskFailed: 0, + leavingPool: 0, + unknown: 0, + unusable: 0, + waitingForStartTask: 0, + total: 0), // Total + }; + + BatchAccountContext context = BatchTestHelpers.CreateBatchContextWithKeys(); + cmdlet.BatchContext = context; + + // Build a PoolNodeCounts instead of querying the service on a Get PoolNodeCounts call + AzureOperationResponse, ProxyModels.AccountListPoolNodeCountsHeaders> response = + BatchTestHelpers.CreatePoolNodeCountsGetResponse(new [] { poolNodeCounts }); + RequestInterceptor interceptor = BatchTestHelpers.CreateFakeServiceResponseInterceptor< + ProxyModels.AccountListPoolNodeCountsOptions, + AzureOperationResponse, ProxyModels.AccountListPoolNodeCountsHeaders>>(response); + + cmdlet.AdditionalBehaviors = new List() { interceptor }; + + List psPoolsNodeCounts = new List(); + commandRuntimeMock.Setup(r => + r.WriteObject(It.IsAny())) + .Callback(p => psPoolsNodeCounts.Add((PSPoolNodeCounts)p)); + + cmdlet.ExecuteCmdlet(); + + var str = PSNodeCounts.FormatObject(psPoolsNodeCounts[0].Dedicated); + const string segmentFormat = "{0}: {1}"; + + Assert.True(str.Contains(string.Format(segmentFormat, nameof(PSNodeCounts.Creating), creating))); + Assert.True(str.Contains(string.Format(segmentFormat, nameof(PSNodeCounts.Idle), idle))); + Assert.True(str.Contains(string.Format(segmentFormat, nameof(PSNodeCounts.Offline), offline))); + Assert.True(str.Contains(string.Format(segmentFormat, nameof(PSNodeCounts.Preempted), preempted))); + Assert.True(str.Contains(string.Format(segmentFormat, nameof(PSNodeCounts.Rebooting), rebooting))); + Assert.True(str.Contains(string.Format(segmentFormat, nameof(PSNodeCounts.Reimaging), reimaging))); + Assert.True(str.Contains(string.Format(segmentFormat, nameof(PSNodeCounts.Running), running))); + Assert.True(str.Contains(string.Format(segmentFormat, nameof(PSNodeCounts.Starting), starting))); + Assert.True(str.Contains(string.Format(segmentFormat, nameof(PSNodeCounts.StartTaskFailed), startTaskFailed))); + Assert.True(str.Contains(string.Format(segmentFormat, nameof(PSNodeCounts.LeavingPool), leavingPool))); + Assert.True(str.Contains(string.Format(segmentFormat, nameof(PSNodeCounts.Unknown), unknown))); + Assert.True(str.Contains(string.Format(segmentFormat, nameof(PSNodeCounts.Unusable), unusable))); + Assert.True(str.Contains(string.Format(segmentFormat, nameof(PSNodeCounts.WaitingForStartTask), waitingForStartTask))); + Assert.True(str.Contains(string.Format(segmentFormat, nameof(PSNodeCounts.Total), total))); + Assert.True(str.EndsWith(string.Format(segmentFormat, nameof(PSNodeCounts.Total), total))); + + str = PSNodeCounts.FormatObject(psPoolsNodeCounts[0].LowPriority); + + Assert.True(str.Contains(string.Format(segmentFormat, nameof(PSNodeCounts.Total), 0))); + } + + public class PoolNodeCountsObjectComparer + { + private IEnumerable poolNodeCountsPropertInfos; + private IEnumerable psPoolNodeCountsPropertInfos; + + public PoolNodeCountsObjectComparer() + { + this.poolNodeCountsPropertInfos = + typeof(ProxyModels.PoolNodeCounts).GetProperties(BindingFlags.Public | BindingFlags.GetProperty); + this.psPoolNodeCountsPropertInfos = + typeof(PSPoolNodeCounts).GetProperties(BindingFlags.Public | BindingFlags.GetProperty); + } + + public bool AreEqual(ProxyModels.PoolNodeCounts poolNodeCounts, PSPoolNodeCounts psPoolNodeCounts) + { + foreach (var pi in this.poolNodeCountsPropertInfos) + { + var poolNodeCountsValue = pi.GetValue(poolNodeCounts); + var psPoolNodeCountsValue = this.psPoolNodeCountsPropertInfos.First(psPi => psPi.Name == pi.Name).GetValue(psPoolNodeCounts); + + if (poolNodeCountsValue != psPoolNodeCountsValue) + { + return false; + } + } + return true; + } + } + } +} diff --git a/src/ResourceManager/AzureBatch/Commands.Batch.Test/packages.config b/src/ResourceManager/AzureBatch/Commands.Batch.Test/packages.config index 8d4ea4749578..4afeb199dbf5 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch.Test/packages.config +++ b/src/ResourceManager/AzureBatch/Commands.Batch.Test/packages.config @@ -1,6 +1,6 @@  - + @@ -19,9 +19,8 @@ - - - + + diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/Commands.Batch.Netcore.csproj b/src/ResourceManager/AzureBatch/Commands.Batch/Commands.Batch.Netcore.csproj index 95a8e80ee38c..a127d6e8226f 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/Commands.Batch.Netcore.csproj +++ b/src/ResourceManager/AzureBatch/Commands.Batch/Commands.Batch.Netcore.csproj @@ -28,7 +28,7 @@ - + diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/Commands.Batch.csproj b/src/ResourceManager/AzureBatch/Commands.Batch/Commands.Batch.csproj index 4f6ce01319d3..8766a8822e02 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/Commands.Batch.csproj +++ b/src/ResourceManager/AzureBatch/Commands.Batch/Commands.Batch.csproj @@ -42,7 +42,7 @@ - ..\..\..\packages\Azure.Batch.8.0.0\lib\net452\Microsoft.Azure.Batch.dll + ..\..\..\packages\Azure.Batch.8.1.1\lib\net452\Microsoft.Azure.Batch.dll ..\..\..\packages\Microsoft.Azure.Management.Batch.4.2.0\lib\net45\Microsoft.Azure.Management.Batch.dll @@ -74,12 +74,15 @@ + + + @@ -158,6 +161,7 @@ + @@ -171,6 +175,7 @@ + diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/ComputeNodes/StartBatchComputeNodeServiceLogUploadCommand.cs b/src/ResourceManager/AzureBatch/Commands.Batch/ComputeNodes/StartBatchComputeNodeServiceLogUploadCommand.cs new file mode 100644 index 000000000000..e2a5e578bd85 --- /dev/null +++ b/src/ResourceManager/AzureBatch/Commands.Batch/ComputeNodes/StartBatchComputeNodeServiceLogUploadCommand.cs @@ -0,0 +1,73 @@ +// ---------------------------------------------------------------------------------- +// +// Copyright Microsoft Corporation +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// http://www.apache.org/licenses/LICENSE-2.0 +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// ---------------------------------------------------------------------------------- + +using System; +using System.Linq; +using Microsoft.Azure.Commands.Batch.Models; +using System.Management.Automation; +using Constants = Microsoft.Azure.Commands.Batch.Utils.Constants; + +namespace Microsoft.Azure.Commands.Batch +{ + [Cmdlet(VerbsLifecycle.Start, + Constants.AzureBatchComputeNodeServiceLogUpload, + SupportsShouldProcess = true, + DefaultParameterSetName = Constants.AzureBatchComputeNodeServiceLogUpload), + OutputType(typeof(PSStartComputeNodeServiceLogUploadResult))] + public class StartBatchComputeNodeServiceLogUploadCommand : BatchObjectModelCmdletBase + { + [Parameter(Position = 0, ParameterSetName = Constants.IdParameterSet, Mandatory = true, + HelpMessage = "The id of the pool that contains the compute node.")] + [ValidateNotNullOrEmpty] + public string PoolId { get; set; } + + [Parameter(Position = 1, ParameterSetName = Constants.IdParameterSet, Mandatory = true, + HelpMessage = "The id of the compute node.")] + [ValidateNotNullOrEmpty] + public string ComputeNodeId { get; set; } + + [Parameter(Position = 1, ParameterSetName = Constants.ParentObjectParameterSet, Mandatory = true, ValueFromPipeline = true)] + [ValidateNotNullOrEmpty] + public PSComputeNode ComputeNode { get; set; } + + [Parameter(Position = 2, Mandatory = true, + HelpMessage = "The URL of the container within Azure Blob Storage to which to upload the Batch Service log file(s)")] + [ValidateNotNullOrEmpty] + public string ContainerUrl { get; set; } + + [Parameter(Position = 3, Mandatory = true, + HelpMessage = "The start of the time range from which to upload Batch Service log file(s).")] + [ValidateNotNullOrEmpty] + public DateTime StartTime { get; set; } + + [Parameter(Mandatory = false, + HelpMessage = "The end of the time range from which to upload Batch Service log file(s).")] + public DateTime? EndTime { get; set; } + + public override void ExecuteCmdlet() + { + StartComputeNodeServiceLogUploadParameters parameters = new StartComputeNodeServiceLogUploadParameters( + this.BatchContext, + this.PoolId, + this.ComputeNodeId, + this.ComputeNode, + this.ContainerUrl, + this.StartTime, + this.EndTime, + this.AdditionalBehaviors); + + WriteObject(BatchClient.StartComputeNodeServiceLogUpload(parameters)); + } + } +} diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/Microsoft.Azure.Commands.Batch.format.ps1xml b/src/ResourceManager/AzureBatch/Commands.Batch/Microsoft.Azure.Commands.Batch.format.ps1xml index 24b3af79d689..6beef41527dd 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/Microsoft.Azure.Commands.Batch.format.ps1xml +++ b/src/ResourceManager/AzureBatch/Commands.Batch/Microsoft.Azure.Commands.Batch.format.ps1xml @@ -16,7 +16,7 @@ - $str = $_ | Select-Object -Property * -ExcludeProperty PrimaryAccessKey,SecondaryAccessKey,Tags | Format-List -Property * | Out-String + $str = $_ | Select-Object -Property * -ExcludeProperty PrimaryAccountKey,SecondaryAccountKey,Tags | Format-List -Property * | Out-String $str @@ -27,5 +27,41 @@ + + Microsoft.Azure.Commands.Batch.Models.PSPoolNodeCounts + + Microsoft.Azure.Commands.Batch.Models.PSPoolNodeCounts + + + + + + 30 + + + + 60 + + + + 60 + + + + + + + PoolId + + + [Microsoft.Azure.Commands.Batch.Models.PSNodeCounts]::FormatObject($_.Dedicated) + + + [Microsoft.Azure.Commands.Batch.Models.PSNodeCounts]::FormatObject($_.LowPriority) + + + + + diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/Models.Generated/PSCloudPool.cs b/src/ResourceManager/AzureBatch/Commands.Batch/Models.Generated/PSCloudPool.cs index e887aa398357..3d3910e96642 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/Models.Generated/PSCloudPool.cs +++ b/src/ResourceManager/AzureBatch/Commands.Batch/Models.Generated/PSCloudPool.cs @@ -411,7 +411,7 @@ public PSNetworkConfiguration NetworkConfiguration this.networkConfiguration = value; } } - + public IReadOnlyList ResizeErrors { get diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/Models.Generated/PSJobPreparationTask.cs b/src/ResourceManager/AzureBatch/Commands.Batch/Models.Generated/PSJobPreparationTask.cs index b1c668a21e57..8e4d7754da47 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/Models.Generated/PSJobPreparationTask.cs +++ b/src/ResourceManager/AzureBatch/Commands.Batch/Models.Generated/PSJobPreparationTask.cs @@ -218,7 +218,7 @@ public IList ResourceFiles this.resourceFiles = value; } } - + public PSUserIdentity UserIdentity { get diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/Models.Generated/PSNodeCounts.cs b/src/ResourceManager/AzureBatch/Commands.Batch/Models.Generated/PSNodeCounts.cs new file mode 100644 index 000000000000..934a1ca02e65 --- /dev/null +++ b/src/ResourceManager/AzureBatch/Commands.Batch/Models.Generated/PSNodeCounts.cs @@ -0,0 +1,158 @@ +// ----------------------------------------------------------------------------- +// +// Copyright Microsoft Corporation +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// http://www.apache.org/licenses/LICENSE-2.0 +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// ----------------------------------------------------------------------------- +//------------------------------------------------------------------------------ +// +// This code was generated by a tool. +// Runtime Version:4.0.30319.42000 +// +// Changes to this file may cause incorrect behavior and will be lost if +// the code is regenerated. +// +//------------------------------------------------------------------------------ + +namespace Microsoft.Azure.Commands.Batch.Models +{ + using System; + using System.Collections; + using System.Collections.Generic; + using Microsoft.Azure.Batch; + + + public partial class PSNodeCounts + { + + internal Microsoft.Azure.Batch.NodeCounts omObject; + + internal PSNodeCounts(Microsoft.Azure.Batch.NodeCounts omObject) + { + if ((omObject == null)) + { + throw new System.ArgumentNullException("omObject"); + } + this.omObject = omObject; + } + + public int Creating + { + get + { + return this.omObject.Creating; + } + } + + public int Idle + { + get + { + return this.omObject.Idle; + } + } + + public int LeavingPool + { + get + { + return this.omObject.LeavingPool; + } + } + + public int Offline + { + get + { + return this.omObject.Offline; + } + } + + public int Preempted + { + get + { + return this.omObject.Preempted; + } + } + + public int Rebooting + { + get + { + return this.omObject.Rebooting; + } + } + + public int Reimaging + { + get + { + return this.omObject.Reimaging; + } + } + + public int Running + { + get + { + return this.omObject.Running; + } + } + + public int Starting + { + get + { + return this.omObject.Starting; + } + } + + public int StartTaskFailed + { + get + { + return this.omObject.StartTaskFailed; + } + } + + public int Total + { + get + { + return this.omObject.Total; + } + } + + public int Unknown + { + get + { + return this.omObject.Unknown; + } + } + + public int Unusable + { + get + { + return this.omObject.Unusable; + } + } + + public int WaitingForStartTask + { + get + { + return this.omObject.WaitingForStartTask; + } + } + } +} diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/Models.Generated/PSPoolNodeCounts.cs b/src/ResourceManager/AzureBatch/Commands.Batch/Models.Generated/PSPoolNodeCounts.cs new file mode 100644 index 000000000000..c9e4b8b65999 --- /dev/null +++ b/src/ResourceManager/AzureBatch/Commands.Batch/Models.Generated/PSPoolNodeCounts.cs @@ -0,0 +1,84 @@ +// ----------------------------------------------------------------------------- +// +// Copyright Microsoft Corporation +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// http://www.apache.org/licenses/LICENSE-2.0 +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// ----------------------------------------------------------------------------- +//------------------------------------------------------------------------------ +// +// This code was generated by a tool. +// Runtime Version:4.0.30319.42000 +// +// Changes to this file may cause incorrect behavior and will be lost if +// the code is regenerated. +// +//------------------------------------------------------------------------------ + +namespace Microsoft.Azure.Commands.Batch.Models +{ + using System; + using System.Collections; + using System.Collections.Generic; + using Microsoft.Azure.Batch; + + + public partial class PSPoolNodeCounts + { + + internal Microsoft.Azure.Batch.PoolNodeCounts omObject; + + private PSNodeCounts dedicated; + + private PSNodeCounts lowPriority; + + internal PSPoolNodeCounts(Microsoft.Azure.Batch.PoolNodeCounts omObject) + { + if ((omObject == null)) + { + throw new System.ArgumentNullException("omObject"); + } + this.omObject = omObject; + } + + public PSNodeCounts Dedicated + { + get + { + if (((this.dedicated == null) + && (this.omObject.Dedicated != null))) + { + this.dedicated = new PSNodeCounts(this.omObject.Dedicated); + } + return this.dedicated; + } + } + + public PSNodeCounts LowPriority + { + get + { + if (((this.lowPriority == null) + && (this.omObject.LowPriority != null))) + { + this.lowPriority = new PSNodeCounts(this.omObject.LowPriority); + } + return this.lowPriority; + } + } + + public string PoolId + { + get + { + return this.omObject.PoolId; + } + } + } +} diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/Models.Generated/PSStartComputeNodeServiceLogUploadResult.cs b/src/ResourceManager/AzureBatch/Commands.Batch/Models.Generated/PSStartComputeNodeServiceLogUploadResult.cs new file mode 100644 index 000000000000..640d73e7fb9f --- /dev/null +++ b/src/ResourceManager/AzureBatch/Commands.Batch/Models.Generated/PSStartComputeNodeServiceLogUploadResult.cs @@ -0,0 +1,62 @@ +// ----------------------------------------------------------------------------- +// +// Copyright Microsoft Corporation +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// http://www.apache.org/licenses/LICENSE-2.0 +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// ----------------------------------------------------------------------------- +//------------------------------------------------------------------------------ +// +// This code was generated by a tool. +// Runtime Version:4.0.30319.42000 +// +// Changes to this file may cause incorrect behavior and will be lost if +// the code is regenerated. +// +//------------------------------------------------------------------------------ + +namespace Microsoft.Azure.Commands.Batch.Models +{ + using System; + using System.Collections; + using System.Collections.Generic; + using Microsoft.Azure.Batch; + + + public partial class PSStartComputeNodeServiceLogUploadResult + { + + internal Microsoft.Azure.Batch.UploadBatchServiceLogsResult omObject; + + internal PSStartComputeNodeServiceLogUploadResult(Microsoft.Azure.Batch.UploadBatchServiceLogsResult omObject) + { + if ((omObject == null)) + { + throw new System.ArgumentNullException("omObject"); + } + this.omObject = omObject; + } + + public int NumberOfFilesUploaded + { + get + { + return this.omObject.NumberOfFilesUploaded; + } + } + + public string VirtualDirectoryName + { + get + { + return this.omObject.VirtualDirectoryName; + } + } + } +} diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/Models/BatchClient.ComputeNodes.cs b/src/ResourceManager/AzureBatch/Commands.Batch/Models/BatchClient.ComputeNodes.cs index 6da6d1c2c387..558c44a48aba 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/Models/BatchClient.ComputeNodes.cs +++ b/src/ResourceManager/AzureBatch/Commands.Batch/Models/BatchClient.ComputeNodes.cs @@ -16,6 +16,8 @@ using Microsoft.Azure.Commands.Batch.Properties; using System; using System.Collections.Generic; +using System.Linq; +using System.Management.Automation; namespace Microsoft.Azure.Commands.Batch.Models { @@ -214,5 +216,31 @@ public PSRemoteLoginSettings ListComputeNodeRemoteLoginSettings(ComputeNodeOpera PSRemoteLoginSettings psRemoteLoginSettings = new PSRemoteLoginSettings(remoteLoginSettings); return psRemoteLoginSettings; } + + public PSStartComputeNodeServiceLogUploadResult StartComputeNodeServiceLogUpload(StartComputeNodeServiceLogUploadParameters parameters) + { + UploadBatchServiceLogsResult result = null; + + if (parameters.ComputeNode != null) + { + result = parameters.ComputeNode.omObject.UploadComputeNodeBatchServiceLogs( + parameters.ContainerUrl, + parameters.StartTime, + parameters.EndTime, + parameters.AdditionalBehaviors); + } + else + { + result = parameters.Context.BatchOMClient.PoolOperations.UploadComputeNodeBatchServiceLogs( + parameters.PoolId, + parameters.ComputeNodeId, + parameters.ContainerUrl, + parameters.StartTime, + parameters.EndTime, + parameters.AdditionalBehaviors); + } + + return new PSStartComputeNodeServiceLogUploadResult(result); + } } } diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/Models/BatchClient.Pools.cs b/src/ResourceManager/AzureBatch/Commands.Batch/Models/BatchClient.Pools.cs index e21008769936..0f986beecd90 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/Models/BatchClient.Pools.cs +++ b/src/ResourceManager/AzureBatch/Commands.Batch/Models/BatchClient.Pools.cs @@ -359,5 +359,39 @@ public IEnumerable ListPoolUsageMetrics(ListPoolUsageOptions return PSPagedEnumerable.CreateWithMaxCount( poolUsageMetrics, p => new PSPoolUsageMetrics(p), Int32.MaxValue, () => WriteVerbose(verboseLogString)); } + + /// + /// Lists the pool node counts matching the specified filter options. + /// + /// The options to use when listing pool node counts. + /// The pool node counts matching the specified filter. + public IEnumerable ListPoolNodeCounts(ListPoolNodeCountsOptions options) + { + if (options == null) + { + throw new ArgumentNullException("options"); + } + + ODATADetailLevel detailLevel = null; + + const string filterStringFormat = "(poolId eq '{0}')"; + + if (!string.IsNullOrEmpty(options.PoolId)) + { + detailLevel = new ODATADetailLevel(string.Format(filterStringFormat, options.PoolId)); + } + else if (options.Pool != null) + { + detailLevel = new ODATADetailLevel(string.Format(filterStringFormat, options.Pool.Id)); + } + + IPagedEnumerable poolNodeCounts = options.Context.BatchOMClient.PoolOperations.ListPoolNodeCounts( + detailLevel, options.AdditionalBehaviors); + + Func mappingFunction = p => { return new PSPoolNodeCounts(p); }; + + return PSPagedEnumerable.CreateWithMaxCount(poolNodeCounts, mappingFunction, + options.MaxCount, () => WriteVerbose(string.Format(Resources.MaxCount, options.MaxCount))); + } } } diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/Models/ListPoolNodeCountsOptions.cs b/src/ResourceManager/AzureBatch/Commands.Batch/Models/ListPoolNodeCountsOptions.cs new file mode 100644 index 000000000000..1608213b3733 --- /dev/null +++ b/src/ResourceManager/AzureBatch/Commands.Batch/Models/ListPoolNodeCountsOptions.cs @@ -0,0 +1,45 @@ +// ---------------------------------------------------------------------------------- +// +// Copyright Microsoft Corporation +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// http://www.apache.org/licenses/LICENSE-2.0 +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// ---------------------------------------------------------------------------------- + +using Microsoft.Azure.Batch; +using System.Collections.Generic; + +namespace Microsoft.Azure.Commands.Batch.Models +{ + public class ListPoolNodeCountsOptions : BatchClientParametersBase + { + /// + /// The maximum number of pools of node counts to return. + /// + public int MaxCount { get; } + + /// + /// The id of the pool. + /// + public string PoolId { get; } + + /// + /// The PSCloudPool object representing the target pool. + /// + public PSCloudPool Pool { get; } + + public ListPoolNodeCountsOptions(BatchAccountContext context, string poolId, PSCloudPool pool, int maxCount, IEnumerable additionalBehaviors = null) + : base(context, additionalBehaviors) + { + this.MaxCount = maxCount; + this.PoolId = poolId; + this.Pool = pool; + } + } +} diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/Models/PSNodeCounts.FormatObject.cs b/src/ResourceManager/AzureBatch/Commands.Batch/Models/PSNodeCounts.FormatObject.cs new file mode 100644 index 000000000000..25f4b0584994 --- /dev/null +++ b/src/ResourceManager/AzureBatch/Commands.Batch/Models/PSNodeCounts.FormatObject.cs @@ -0,0 +1,76 @@ +// ---------------------------------------------------------------------------------- +// +// Copyright Microsoft Corporation +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// http://www.apache.org/licenses/LICENSE-2.0 +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// ---------------------------------------------------------------------------------- + +using System; +using System.Collections.Generic; +using System.Reflection; + +namespace Microsoft.Azure.Commands.Batch.Models +{ + public partial class PSNodeCounts + { + private static PropertyInfo[] psNodeCountsPropertyInfos; + + public static string FormatObject(PSNodeCounts psNodeCounts) + { + var propertyInfos = GetPropertyInfos(); + + var propertyStrings = new List(); + + Tuple totalPropertyInfo = null; + + foreach (var propertyInfo in propertyInfos) + { + var propertyValue = propertyInfo.GetValue(psNodeCounts); + + if (propertyValue != null + && propertyInfo.PropertyType == typeof (int)) + { + int intValue; + + if (Int32.TryParse(propertyValue.ToString(), out intValue)) + { + // Always print total at the end of string. + if (string.Equals(propertyInfo.Name, nameof(Total), StringComparison.OrdinalIgnoreCase)) + { + totalPropertyInfo = new Tuple(propertyInfo.Name, intValue); + } + // Only print numbers > 0 for other node states. + else if (intValue > 0) + { + propertyStrings.Add($"{propertyInfo.Name}: {propertyValue}"); + } + } + } + } + + if (totalPropertyInfo != null) + { + propertyStrings.Add($"{totalPropertyInfo.Item1}: {totalPropertyInfo.Item2}"); + } + + return string.Join(", ", propertyStrings); + } + + private static PropertyInfo[] GetPropertyInfos() + { + if (psNodeCountsPropertyInfos == null) + { + psNodeCountsPropertyInfos = typeof(PSNodeCounts).GetProperties(BindingFlags.Public | BindingFlags.GetProperty | BindingFlags.Instance); + } + + return psNodeCountsPropertyInfos; + } + } +} diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/Models/StartComputeNodeServiceLogUploadParameters.cs b/src/ResourceManager/AzureBatch/Commands.Batch/Models/StartComputeNodeServiceLogUploadParameters.cs new file mode 100644 index 000000000000..eeceeb1d3128 --- /dev/null +++ b/src/ResourceManager/AzureBatch/Commands.Batch/Models/StartComputeNodeServiceLogUploadParameters.cs @@ -0,0 +1,54 @@ +// ---------------------------------------------------------------------------------- +// +// Copyright Microsoft Corporation +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// http://www.apache.org/licenses/LICENSE-2.0 +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// ---------------------------------------------------------------------------------- + +using System; +using Microsoft.Azure.Batch; +using System.Collections.Generic; + +namespace Microsoft.Azure.Commands.Batch.Models +{ + public class StartComputeNodeServiceLogUploadParameters : ComputeNodeOperationParameters + { + public string ContainerUrl { get; } + + public DateTime StartTime { get; } + + public DateTime? EndTime { get; } + + public StartComputeNodeServiceLogUploadParameters(BatchAccountContext context, + string poolId, + string computeNodeId, + PSComputeNode computeNode, + string containerUrl, + DateTime startTime, + DateTime? endTime, + IEnumerable additionalBehaviors = null) + : base(context, poolId, computeNodeId, computeNode, additionalBehaviors) + { + if (string.IsNullOrWhiteSpace(containerUrl)) + { + throw new ArgumentNullException(nameof(containerUrl), Properties.Resources.NoContainerUrl); + } + + if (startTime <= DateTime.MinValue) + { + throw new ArgumentException(nameof(startTime), Properties.Resources.NoStartTime); + } + + this.ContainerUrl = containerUrl; + this.StartTime = startTime; + this.EndTime = endTime; + } + } +} diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/Pools/GetBatchPoolNodeCountsCommand.cs b/src/ResourceManager/AzureBatch/Commands.Batch/Pools/GetBatchPoolNodeCountsCommand.cs new file mode 100644 index 000000000000..b635206557c2 --- /dev/null +++ b/src/ResourceManager/AzureBatch/Commands.Batch/Pools/GetBatchPoolNodeCountsCommand.cs @@ -0,0 +1,55 @@ +// ---------------------------------------------------------------------------------- +// +// Copyright Microsoft Corporation +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// http://www.apache.org/licenses/LICENSE-2.0 +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// ---------------------------------------------------------------------------------- + +using System.Collections.Generic; +using Microsoft.Azure.Commands.Batch.Models; +using System.Management.Automation; +using Constants = Microsoft.Azure.Commands.Batch.Utils.Constants; + +namespace Microsoft.Azure.Commands.Batch +{ + [Cmdlet(VerbsCommon.Get, + Constants.AzureBatchPoolNodeCounts, + DefaultParameterSetName = Constants.AzureBatchPoolNodeCounts), + OutputType(typeof(PSPoolNodeCounts))] + public class GetBatchPoolNodeCountsCommand : BatchObjectModelCmdletBase + { + private const int defaultMaxCount = 10; + + [Parameter(ParameterSetName = Constants.PoolIdParameterSet, Mandatory = false, + ValueFromPipelineByPropertyName = true, HelpMessage = "The id of the pool for which to get node counts.")] + [ValidateNotNullOrEmpty] + public string PoolId { get; set; } + + [Parameter(ParameterSetName = Constants.ParentObjectParameterSet, + ValueFromPipeline = true, Mandatory = false, HelpMessage = "The pool object for which to get node counts.")] + [ValidateNotNullOrEmpty] + public PSCloudPool Pool { get; set; } + + [Parameter(ParameterSetName = Constants.ODataFilterParameterSet), ValidateRange(1, defaultMaxCount)] + public int MaxCount { get; set; } = defaultMaxCount; + + public override void ExecuteCmdlet() + { + ListPoolNodeCountsOptions options = new ListPoolNodeCountsOptions(this.BatchContext, this.PoolId, this.Pool, this.MaxCount, this.AdditionalBehaviors); + + IEnumerable pagedPoolNodeCounts = BatchClient.ListPoolNodeCounts(options); + + foreach (var poolNodeCounts in pagedPoolNodeCounts) + { + WriteObject(poolNodeCounts); + } + } + } +} diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/Properties/Resources.Designer.cs b/src/ResourceManager/AzureBatch/Commands.Batch/Properties/Resources.Designer.cs index 471bbd4d3780..52ee25ccaf26 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/Properties/Resources.Designer.cs +++ b/src/ResourceManager/AzureBatch/Commands.Batch/Properties/Resources.Designer.cs @@ -780,6 +780,15 @@ internal static string NoComputeNodeUser { } } + /// + /// Looks up a localized string similar to No container url specified. The container url should include Shared access signature for the Azure Storage container.. + /// + internal static string NoContainerUrl { + get { + return ResourceManager.GetString("NoContainerUrl", resourceCulture); + } + } + /// /// Looks up a localized string similar to No destination was provided for the downloaded file. Either provide a file path or a Stream object.. /// @@ -834,6 +843,15 @@ internal static string NoPool { } } + /// + /// Looks up a localized string similar to No start time specified.. + /// + internal static string NoStartTime { + get { + return ResourceManager.GetString("NoStartTime", resourceCulture); + } + } + /// /// Looks up a localized string similar to No task was specified. Supply a PSCloudTask object or a job id and task id.. /// diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/Properties/Resources.resx b/src/ResourceManager/AzureBatch/Commands.Batch/Properties/Resources.resx index 2b55d06df582..d22df7d3ef63 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/Properties/Resources.resx +++ b/src/ResourceManager/AzureBatch/Commands.Batch/Properties/Resources.resx @@ -490,4 +490,10 @@ Getting task counts for job {0}. + + No container url specified. The container url should include Shared access signature for the Azure Storage container. + + + No start time specified. + \ No newline at end of file diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/Utils/Constants.cs b/src/ResourceManager/AzureBatch/Commands.Batch/Utils/Constants.cs index e38d53556e3b..9693aa248fc8 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/Utils/Constants.cs +++ b/src/ResourceManager/AzureBatch/Commands.Batch/Utils/Constants.cs @@ -50,6 +50,8 @@ public class Constants public const string AzureBatchCertificate = "AzureBatchCertificate"; public const string AzureBatchCertificateDeletion = "AzureBatchCertificateDeletion"; public const string AzureBatchNodeAgentSku = "AzureBatchNodeAgentSku"; + public const string AzureBatchPoolNodeCounts = "AzureBatchPoolNodeCounts"; + public const string AzureBatchComputeNodeServiceLogUpload = "AzureBatchComputeNodeServiceLogUpload"; // Parameter sets public const string IdParameterSet = "Id"; @@ -58,5 +60,6 @@ public class Constants public const string ParentObjectParameterSet = "ParentObject"; public const string InputObjectAndPathParameterSet = "InputObject_Path"; public const string InputObjectAndStreamParameterSet = "InputObject_Stream"; + public const string PoolIdParameterSet = "PoolId"; } } diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/AzureRM.Batch.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/AzureRM.Batch.md index 5a0ca030e91a..65c4975fb12a 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/AzureRM.Batch.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/AzureRM.Batch.md @@ -1,4 +1,4 @@ ---- +--- Module Name: AzureRM.Batch Module Guid: a8f00f40-1c1a-49b5-9db3-24076b75c3cf Download Help Link: https://docs.microsoft.com/en-us/powershell/module/azurerm.batch @@ -68,6 +68,9 @@ Gets a Batch node file. ### [Get-AzureBatchPool](Get-AzureBatchPool.md) Gets Batch pools under the specified Batch account. +### [Get-AzureBatchPoolNodeCounts](Get-AzureBatchPoolNodeCounts.md) +Gets Batch node counts per node state grouped by pool id. + ### [Get-AzureBatchPoolStatistics](Get-AzureBatchPoolStatistics.md) Gets pool summary statistics for a Batch account. @@ -86,6 +89,9 @@ Gets the subtask information of the specified task. ### [Get-AzureBatchTask](Get-AzureBatchTask.md) Gets the Batch tasks for a job. +### [Get-AzureBatchTaskCounts](Get-AzureBatchTaskCounts.md) +Gets the task counts for the specified job. + ### [Get-AzureRmBatchAccount](Get-AzureRmBatchAccount.md) Gets a Batch account in the current subscription. @@ -194,6 +200,9 @@ Updates a Batch account. ### [Set-AzureRmBatchApplication](Set-AzureRmBatchApplication.md) Updates settings for the specified application. +### [Start-AzureBatchComputeNodeServiceLogUpload](Start-AzureBatchComputeNodeServiceLogUpload.md) +Upload compute node service log files to an Azure Storage container. + ### [Start-AzureBatchPoolResize](Start-AzureBatchPoolResize.md) Starts to resize a pool. diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Disable-AzureBatchAutoScale.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Disable-AzureBatchAutoScale.md index 0f1ee3019e6a..0a1aa0794074 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Disable-AzureBatchAutoScale.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Disable-AzureBatchAutoScale.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml Module Name: AzureRM.Batch ms.assetid: 9C755BE8-0624-4CF7-AE7C-34DAF44678E8 @@ -39,7 +39,7 @@ If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, t ```yaml Type: BatchAccountContext Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named @@ -69,7 +69,7 @@ Specifies the object ID of the pool. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 0 diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Disable-AzureBatchComputeNodeScheduling.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Disable-AzureBatchComputeNodeScheduling.md index bcf10deb5c4f..8163e5d75186 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Disable-AzureBatchComputeNodeScheduling.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Disable-AzureBatchComputeNodeScheduling.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml Module Name: AzureRM.Batch ms.assetid: 2DF5FB4D-A5CB-439C-AC6F-DF2130AF33EC @@ -80,7 +80,7 @@ If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, t ```yaml Type: BatchAccountContext Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named @@ -96,7 +96,7 @@ This object reference is created by using the Get-AzureBatchComputeNode cmdlet a ```yaml Type: PSComputeNode Parameter Sets: InputObject -Aliases: +Aliases: Required: False Position: 0 @@ -141,7 +141,7 @@ No new tasks will be scheduled on this node. ```yaml Type: DisableComputeNodeSchedulingOption Parameter Sets: (All) -Aliases: +Aliases: Accepted values: Requeue, Terminate, TaskCompletion Required: False @@ -157,7 +157,7 @@ Specifies the ID of the compute node where task scheduling is disabled. ```yaml Type: String Parameter Sets: Id -Aliases: +Aliases: Required: True Position: 1 @@ -174,7 +174,7 @@ If you use the *PoolId* parameter, do not use the *ComputeNode* parameter in tha ```yaml Type: String Parameter Sets: Id -Aliases: +Aliases: Required: True Position: 0 diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Disable-AzureBatchJob.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Disable-AzureBatchJob.md index e91a4ce08e8a..496f670ae016 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Disable-AzureBatchJob.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Disable-AzureBatchJob.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml Module Name: AzureRM.Batch ms.assetid: C831F934-7513-4882-A155-816E56CD9807 @@ -44,7 +44,7 @@ If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, t ```yaml Type: BatchAccountContext Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named @@ -79,7 +79,7 @@ Valid values are: ```yaml Type: DisableJobOption Parameter Sets: (All) -Aliases: +Aliases: Accepted values: Requeue, Terminate, Wait Required: True @@ -95,7 +95,7 @@ Specifies the ID of the job that this cmdlet disables. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 0 diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Disable-AzureBatchJobSchedule.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Disable-AzureBatchJobSchedule.md index b0285a11797a..82d59a37d0b5 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Disable-AzureBatchJobSchedule.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Disable-AzureBatchJobSchedule.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml Module Name: AzureRM.Batch ms.assetid: B4737AE8-F57C-4B95-B81E-74802EF8E7AE @@ -42,7 +42,7 @@ If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, t ```yaml Type: BatchAccountContext Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named @@ -72,7 +72,7 @@ Specifies the ID of the job schedule that this cmdlet disables. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 0 diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Enable-AzureBatchAutoScale.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Enable-AzureBatchAutoScale.md index 4fdee1b668b5..e48f5769d39b 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Enable-AzureBatchAutoScale.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Enable-AzureBatchAutoScale.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml Module Name: AzureRM.Batch ms.assetid: 3107D061-7F25-45D0-8029-C99120A156DA @@ -43,7 +43,7 @@ The default value is 15 minutes, and the minimum value is 5 minutes. ```yaml Type: TimeSpan Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: 2 @@ -58,7 +58,7 @@ Specifies the formula for the desired number of compute nodes in the pool. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: 1 @@ -74,7 +74,7 @@ If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, t ```yaml Type: BatchAccountContext Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named @@ -104,7 +104,7 @@ Specifies the object ID of the pool for which to enable automatic scaling. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 0 diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Enable-AzureBatchComputeNodeScheduling.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Enable-AzureBatchComputeNodeScheduling.md index cc341a1ed08a..27ccd766b859 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Enable-AzureBatchComputeNodeScheduling.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Enable-AzureBatchComputeNodeScheduling.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml Module Name: AzureRM.Batch ms.assetid: 36EB9CE6-EAC9-471C-97D6-14E882E0F710 @@ -65,7 +65,7 @@ If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, t ```yaml Type: BatchAccountContext Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named @@ -81,7 +81,7 @@ This object reference is created by using the Get-AzureBatchComputeNode cmdlet a ```yaml Type: PSComputeNode Parameter Sets: InputObject -Aliases: +Aliases: Required: False Position: 0 @@ -111,7 +111,7 @@ Specifies the ID of the compute node where task scheduling is enabled. ```yaml Type: String Parameter Sets: Id -Aliases: +Aliases: Required: True Position: 1 @@ -126,7 +126,7 @@ Specifies the ID of the batch pool that contains the compute node where task sch ```yaml Type: String Parameter Sets: Id -Aliases: +Aliases: Required: True Position: 0 diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Enable-AzureBatchJob.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Enable-AzureBatchJob.md index 7c617699ce63..473b9da7abbf 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Enable-AzureBatchJob.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Enable-AzureBatchJob.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml Module Name: AzureRM.Batch ms.assetid: 7C79BFF1-41E1-472D-AF67-1C3B39AB7548 @@ -41,7 +41,7 @@ If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, t ```yaml Type: BatchAccountContext Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named @@ -71,7 +71,7 @@ Specifies the ID of the job that this cmdlet enables. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 0 diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Enable-AzureBatchJobSchedule.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Enable-AzureBatchJobSchedule.md index c6670c583cf5..abc3e33edaec 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Enable-AzureBatchJobSchedule.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Enable-AzureBatchJobSchedule.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml Module Name: AzureRM.Batch ms.assetid: 02F91510-F14F-4401-BC5F-06B0874AEB4B @@ -41,7 +41,7 @@ If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, t ```yaml Type: BatchAccountContext Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named @@ -71,7 +71,7 @@ Specifies the ID of the job schedule that this cmdlet enables. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 0 diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Enable-AzureBatchTask.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Enable-AzureBatchTask.md index 0da43d89e999..1df6035357e7 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Enable-AzureBatchTask.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Enable-AzureBatchTask.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml Module Name: AzureRM.Batch ms.assetid: 67FB5D02-4F4B-4119-B3AC-0D205247253E @@ -56,7 +56,7 @@ If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, t ```yaml Type: BatchAccountContext Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named @@ -86,7 +86,7 @@ Specifies the ID of the task to reactivate. ```yaml Type: String Parameter Sets: Id -Aliases: +Aliases: Required: True Position: 1 @@ -101,7 +101,7 @@ Specifies the ID of the job that contains the task. ```yaml Type: String Parameter Sets: Id -Aliases: +Aliases: Required: True Position: 0 @@ -117,7 +117,7 @@ To obtain a **PSCloudTask** object, use the Get-AzureBatchTask cmdlet. ```yaml Type: PSCloudTask Parameter Sets: InputObject -Aliases: +Aliases: Required: True Position: 0 diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchCertificate.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchCertificate.md index 3805b5402c62..51e625fcad18 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchCertificate.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchCertificate.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml Module Name: AzureRM.Batch ms.assetid: A9C98F8F-90F2-4BF4-A234-31966FBB975B @@ -110,7 +110,7 @@ If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, t ```yaml Type: BatchAccountContext Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named @@ -141,7 +141,7 @@ If you specify this parameter, this cmdlet gets the certificates that match the ```yaml Type: String Parameter Sets: ODataFilter -Aliases: +Aliases: Required: False Position: Named @@ -158,7 +158,7 @@ The default value is 1000. ```yaml Type: Int32 Parameter Sets: ODataFilter -Aliases: +Aliases: Required: False Position: Named @@ -174,7 +174,7 @@ Specify a value for this parameter to get specific properties rather than all ob ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -189,7 +189,7 @@ Specifies the thumbprint of the certificate that this cmdlet gets. ```yaml Type: String Parameter Sets: Thumbprint -Aliases: +Aliases: Required: True Position: 1 @@ -205,7 +205,7 @@ Currently, the only valid value is sha1. ```yaml Type: String Parameter Sets: Thumbprint -Aliases: +Aliases: Required: True Position: 0 diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchComputeNode.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchComputeNode.md index dde6acc8ebe0..81bf03bb46a0 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchComputeNode.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchComputeNode.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml Module Name: AzureRM.Batch ms.assetid: 93614655-A8F2-4A67-887D-43D41AB91F82 @@ -152,7 +152,7 @@ If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, t ```yaml Type: BatchAccountContext Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named @@ -184,7 +184,7 @@ If you do not specify a filter, this cmdlet returns all compute nodes for the po ```yaml Type: String Parameter Sets: ODataFilter, ParentObject -Aliases: +Aliases: Required: False Position: Named @@ -200,7 +200,7 @@ You cannot specify wildcard characters. ```yaml Type: String Parameter Sets: Id -Aliases: +Aliases: Required: False Position: 1 @@ -217,7 +217,7 @@ The default value is 1000. ```yaml Type: Int32 Parameter Sets: ODataFilter, ParentObject -Aliases: +Aliases: Required: False Position: Named @@ -233,7 +233,7 @@ To obtain a **PSCloudPool** object, use the Get-AzureBatchPool cmdlet. ```yaml Type: PSCloudPool Parameter Sets: ParentObject -Aliases: +Aliases: Required: False Position: 0 @@ -248,7 +248,7 @@ Specifies the ID of the pool that contains the compute nodes. ```yaml Type: String Parameter Sets: ODataFilter, Id -Aliases: +Aliases: Required: True Position: 0 @@ -264,7 +264,7 @@ Specify a value for this parameter to get specific properties rather than all ob ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchJob.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchJob.md index fb1825370f70..7fa470a7c282 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchJob.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchJob.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml Module Name: AzureRM.Batch ms.assetid: 8BF49C4D-E7CD-4FD0-AFAC-9856239D24EC @@ -134,7 +134,7 @@ If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, t ```yaml Type: BatchAccountContext Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named @@ -165,7 +165,7 @@ Specify a value for this parameter to get associated entities of the main entity ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -181,7 +181,7 @@ If you do not specify a filter, this cmdlet returns all jobs for the Batch accou ```yaml Type: String Parameter Sets: ODataFilter, ParentObject -Aliases: +Aliases: Required: False Position: Named @@ -197,7 +197,7 @@ You cannot specify wildcard characters. ```yaml Type: String Parameter Sets: Id -Aliases: +Aliases: Required: False Position: 0 @@ -213,7 +213,7 @@ To obtain a **PSCloudJobSchedule** object, use the Get-AzureBatchJobSchedule cmd ```yaml Type: PSCloudJobSchedule Parameter Sets: ParentObject -Aliases: +Aliases: Required: False Position: 0 @@ -228,7 +228,7 @@ Specifies the ID of the job schedule which contains the jobs. ```yaml Type: String Parameter Sets: ODataFilter -Aliases: +Aliases: Required: False Position: Named @@ -245,7 +245,7 @@ The default value is 1000. ```yaml Type: Int32 Parameter Sets: ODataFilter, ParentObject -Aliases: +Aliases: Required: False Position: Named @@ -261,7 +261,7 @@ Specify a value for this parameter to get specific properties rather than all ob ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchJobPreparationAndReleaseTaskStatus.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchJobPreparationAndReleaseTaskStatus.md index 3124a959ccce..d5d7375df9e3 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchJobPreparationAndReleaseTaskStatus.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchJobPreparationAndReleaseTaskStatus.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml Module Name: AzureRM.Batch online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.batch/get-azurebatchjobpreparationandreleasetaskstatus @@ -68,7 +68,7 @@ Use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object w ```yaml Type: BatchAccountContext Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named @@ -99,7 +99,7 @@ Specify a value for this parameter to get associated entities of the main entity ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -115,7 +115,7 @@ If you do not specify a filter, this cmdlet returns all job preparation and rele ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -131,7 +131,7 @@ You cannot specify wildcard characters. ```yaml Type: String Parameter Sets: Id -Aliases: +Aliases: Required: True Position: 0 @@ -147,7 +147,7 @@ To obtain a **PSCloudJob** object, use the Get-AzureBatchJob cmdlet. ```yaml Type: PSCloudJob Parameter Sets: InputObject -Aliases: +Aliases: Required: True Position: 0 @@ -164,7 +164,7 @@ The default value is 1000. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -180,7 +180,7 @@ Specify a value for this parameter to get specific properties rather than all ob ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchJobSchedule.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchJobSchedule.md index 4d1c8a771735..3f104d0d7234 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchJobSchedule.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchJobSchedule.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml Module Name: AzureRM.Batch ms.assetid: 8BAA6D8C-1530-4CC4-8AE5-A2CE6B1192CA @@ -102,7 +102,7 @@ If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, t ```yaml Type: BatchAccountContext Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named @@ -133,7 +133,7 @@ Specify a value for this parameter to get associated entities of the main entity ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -150,7 +150,7 @@ If you do not specify a filter, this cmdlet returns all job schedules for the Ba ```yaml Type: String Parameter Sets: ODataFilter -Aliases: +Aliases: Required: False Position: Named @@ -166,7 +166,7 @@ You cannot specify wildcard characters. ```yaml Type: String Parameter Sets: Id -Aliases: +Aliases: Required: False Position: 0 @@ -183,7 +183,7 @@ The default value is 1000. ```yaml Type: Int32 Parameter Sets: ODataFilter -Aliases: +Aliases: Required: False Position: Named @@ -199,7 +199,7 @@ Specify a value for this parameter to get specific properties rather than all ob ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchJobStatistics.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchJobStatistics.md index 0a4fedc5dd7f..07266a03f1ac 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchJobStatistics.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchJobStatistics.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml Module Name: AzureRM.Batch ms.assetid: E655684D-9601-4A0B-BB09-EFB787EB2B1B @@ -58,7 +58,7 @@ If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, t ```yaml Type: BatchAccountContext Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchNodeAgentSku.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchNodeAgentSku.md index 181819dc747f..926a81b47a29 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchNodeAgentSku.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchNodeAgentSku.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml Module Name: AzureRM.Batch ms.assetid: 5C6D3792-AA56-4210-B376-D9E656B04FBD @@ -51,7 +51,7 @@ If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, t ```yaml Type: BatchAccountContext Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named @@ -82,7 +82,7 @@ If you do not specify a filter, this cmdlet returns all node agent SKUs that Bat ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -97,7 +97,7 @@ Specifies the maximum number of node agent SKUs to return. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchNodeFile.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchNodeFile.md index 2e8427209e03..0b2df7d65357 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchNodeFile.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchNodeFile.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml Module Name: AzureRM.Batch ms.assetid: 38ED2854-23D0-400E-A5C8-239346B2AF99 @@ -148,7 +148,7 @@ If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, t ```yaml Type: BatchAccountContext Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named @@ -164,7 +164,7 @@ To obtain a compute node object, use the Get-AzureBatchComputeNode cmdlet. ```yaml Type: PSComputeNode Parameter Sets: ParentComputeNode -Aliases: +Aliases: Required: False Position: 0 @@ -179,7 +179,7 @@ Specifies the ID of the compute node that contains the Batch node files. ```yaml Type: String Parameter Sets: ComputeNode_Id, ComputeNode_ODataFilter -Aliases: +Aliases: Required: True Position: 1 @@ -210,7 +210,7 @@ This cmdlet returns properties for node files that match the filter that this pa ```yaml Type: String Parameter Sets: Task_ODataFilter, ParentTask, ComputeNode_ODataFilter, ParentComputeNode -Aliases: +Aliases: Required: False Position: Named @@ -225,7 +225,7 @@ Specifies the ID of the job that contains the target task. ```yaml Type: String Parameter Sets: Task_Id, Task_ODataFilter -Aliases: +Aliases: Required: True Position: Named @@ -242,7 +242,7 @@ The default value is 1000. ```yaml Type: Int32 Parameter Sets: Task_ODataFilter, ParentTask, ComputeNode_ODataFilter, ParentComputeNode -Aliases: +Aliases: Required: False Position: Named @@ -273,7 +273,7 @@ Specifies the ID of the pool that contains the compute node from which to get pr ```yaml Type: String Parameter Sets: ComputeNode_Id, ComputeNode_ODataFilter -Aliases: +Aliases: Required: True Position: 0 @@ -289,7 +289,7 @@ Otherwise, it returns only the files in the root folder. ```yaml Type: SwitchParameter Parameter Sets: Task_ODataFilter, ParentTask, ComputeNode_ODataFilter, ParentComputeNode -Aliases: +Aliases: Required: False Position: Named @@ -305,7 +305,7 @@ To obtain a task object, use the Get-AzureBatchTask cmdlet. ```yaml Type: PSCloudTask Parameter Sets: ParentTask -Aliases: +Aliases: Required: False Position: 0 @@ -320,7 +320,7 @@ Specifies the ID of the task for which this cmdlet gets properties of node files ```yaml Type: String Parameter Sets: Task_Id, Task_ODataFilter -Aliases: +Aliases: Required: True Position: Named diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchNodeFileContent.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchNodeFileContent.md index ea020ed4606a..334cef2ef9bf 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchNodeFileContent.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchNodeFileContent.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml Module Name: AzureRM.Batch ms.assetid: C9E2D9EC-3B6A-492D-B183-9856185548CD @@ -128,7 +128,7 @@ If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, t ```yaml Type: BatchAccountContext Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named @@ -142,7 +142,7 @@ The end of the byte range to be downloaded. ```yaml Type: Int64 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -156,7 +156,7 @@ The start of the byte range to be downloaded. ```yaml Type: Int64 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -171,7 +171,7 @@ Specifies the ID of the compute node that contains the node file that this cmdle ```yaml Type: String Parameter Sets: ComputeNode_Id_Path, ComputeNode_Id_Stream -Aliases: +Aliases: Required: True Position: 1 @@ -201,7 +201,7 @@ Specifies the file path where this cmdlet saves the node file. ```yaml Type: String Parameter Sets: Task_Id_Path, ComputeNode_Id_Path, InputObject_Path -Aliases: +Aliases: Required: True Position: Named @@ -217,7 +217,7 @@ This cmdlet does not close or rewind this stream. ```yaml Type: Stream Parameter Sets: Task_Id_Stream, ComputeNode_Id_Stream, InputObject_Stream -Aliases: +Aliases: Required: True Position: Named @@ -233,7 +233,7 @@ To obtain a node file object, use the Get-AzureBatchNodeFile cmdlet. ```yaml Type: PSNodeFile Parameter Sets: InputObject_Path, InputObject_Stream -Aliases: +Aliases: Required: False Position: 0 @@ -248,7 +248,7 @@ Specifies the ID of the job that contains the target task. ```yaml Type: String Parameter Sets: Task_Id_Path, Task_Id_Stream -Aliases: +Aliases: Required: True Position: Named @@ -278,7 +278,7 @@ Specifies the ID of the pool that contains the compute node that contains the no ```yaml Type: String Parameter Sets: ComputeNode_Id_Path, ComputeNode_Id_Stream -Aliases: +Aliases: Required: True Position: 0 @@ -293,7 +293,7 @@ Specifies the ID of the task. ```yaml Type: String Parameter Sets: Task_Id_Path, Task_Id_Stream -Aliases: +Aliases: Required: True Position: Named diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchPool.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchPool.md index 3093a6282e81..6db33d1a59c0 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchPool.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchPool.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml Module Name: AzureRM.Batch ms.assetid: 44D877F1-D066-4C9C-A797-05EF03785B54 @@ -110,7 +110,7 @@ If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, t ```yaml Type: BatchAccountContext Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named @@ -141,7 +141,7 @@ Specify a value for this parameter to get associated entities of the main entity ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -157,7 +157,7 @@ If you do not specify a filter, all pools under the Batch account specified with ```yaml Type: String Parameter Sets: ODataFilter -Aliases: +Aliases: Required: False Position: Named @@ -173,7 +173,7 @@ You cannot specify wildcard characters. ```yaml Type: String Parameter Sets: Id -Aliases: +Aliases: Required: False Position: 0 @@ -190,7 +190,7 @@ The default value is 1000. ```yaml Type: Int32 Parameter Sets: ODataFilter -Aliases: +Aliases: Required: False Position: Named @@ -206,7 +206,7 @@ Specify a value for this parameter to get specific properties rather than all ob ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchPoolNodeCounts.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchPoolNodeCounts.md new file mode 100644 index 000000000000..5b2931693b66 --- /dev/null +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchPoolNodeCounts.md @@ -0,0 +1,197 @@ +--- +external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml +Module Name: AzureRM.Batch +online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.batch/get-azurebatchpoolnodecounts +schema: 2.0.0 +--- + +# Get-AzureBatchPoolNodeCounts + +## SYNOPSIS +Gets Batch node counts per node state grouped by pool id. + +## SYNTAX + +### AzureBatchPoolNodeCounts (Default) +``` +Get-AzureBatchPoolNodeCounts -BatchContext [-DefaultProfile ] + [] +``` + +### PoolId +``` +Get-AzureBatchPoolNodeCounts [-PoolId ] -BatchContext + [-DefaultProfile ] [] +``` + +### ParentObject +``` +Get-AzureBatchPoolNodeCounts [-Pool ] -BatchContext + [-DefaultProfile ] [] +``` + +### ODataFilter +``` +Get-AzureBatchPoolNodeCounts [-MaxCount ] -BatchContext + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The Get-AzureBatchPoolNodeCounts cmdlet allows customers to get back node counts per node state grouped by pool. Possible node states are creating, idle, leavingPool, offline, preempted, rebooting, reimaging, running, starting, startTaskFailed, unknown, unusable and waitingForStartTask. The cmdlet takes PoolId or Pool parameter to filter only pool with pool id specified. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> $batchContext = Get-AzureRmBatchAccountKeys -AccountName "contosobatch" +PS C:\> Get-AzureBatchPoolNodeCounts -BatchContext $batchContext + +PoolId Dedicated LowPriority +------ --------- ----------- +contosopool1 Creating: 1, Idle: 1, Rebooting: 1, Running: 5, Total: 8 Total: 0 +contosopool2 Idle: 1, Rebooting: 1, Total: 2 Total: 0 +``` + +List node counts per node state for pools under current batch account context. + +### Example 2 + +```powershell +PS C:\> Get-AzureBatchPoolNodeCounts -BatchContext $batchContext -PoolId "contosopool1" + +PoolId Dedicated LowPriority +------ --------- ----------- +contosopool1 Creating: 1, Idle: 1, Rebooting: 1, Running: 5, Total: 8 Total: 0 + +PS C:\> $poolnodecounts = Get-AzureBatchPoolNodeCounts -BatchContext $batchContext -PoolId "contosopool1" +PS C:\> $poolnodecounts.Dedicated + +Creating : 1 +Idle : 1 +LeavingPool : 0 +Offline : 0 +Preempted : 0 +Rebooting : 1 +Reimaging : 0 +Running : 5 +Starting : 0 +StartTaskFailed : 0 +Total : 8 +Unknown : 0 +Unusable : 0 +WaitingForStartTask : 0 + +PS C:\> Get-AzureBatchPool -Id "contosopool1" -BatchContext $batchContext | Get-AzureBatchPoolNodeCounts -BatchContext $batchContext + +PoolId Dedicated LowPriority +------ --------- ----------- +contosopool1 Creating: 1, Idle: 1, Rebooting: 1, Running: 5, Total: 8 Total: 0 +``` + +Show node counts per node state for a pool given pool id. + +## PARAMETERS + +### -BatchContext +The BatchAccountContext instance to use when interacting with the Batch service. +If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, then Azure Active Directory authentication will be used when interacting with the Batch service. +To use shared key authentication instead, use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated. +When using shared key authentication, the primary access key is used by default. +To change the key to use, set the BatchAccountContext.KeyInUse property. + +```yaml +Type: BatchAccountContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxCount +Specifies the maximum number of pools to return. +The default value is 10. + +```yaml +Type: Int32 +Parameter Sets: ODataFilter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Pool +Specifies the **PSCloudPool** for which to get node counts. + +```yaml +Type: PSCloudPool +Parameter Sets: ParentObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PoolId +The id of the pool for which to get node counts. + +```yaml +Type: String +Parameter Sets: PoolId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String +Microsoft.Azure.Commands.Batch.Models.PSCloudJob Microsoft.Azure.Commands.Batch.BatchAccountContext + +## OUTPUTS + +### Microsoft.Azure.Commands.Batch.Models.PSTaskCounts + +## NOTES + +## RELATED LINKS + +[Get-AzureRmBatchAccountKeys]() + +[Get-AzureBatchJob]() + +[Azure Batch Cmdlets]() + diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchPoolStatistics.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchPoolStatistics.md index 16423c87e025..b7c67c78a6b3 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchPoolStatistics.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchPoolStatistics.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml Module Name: AzureRM.Batch ms.assetid: 8188C617-4895-4B43-8D3B-FA6FC5B868DD @@ -60,7 +60,7 @@ If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, t ```yaml Type: BatchAccountContext Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchPoolUsageMetrics.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchPoolUsageMetrics.md index 4a548650784c..3782cad8997b 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchPoolUsageMetrics.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchPoolUsageMetrics.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml Module Name: AzureRM.Batch ms.assetid: 4B373447-3078-4C1F-932E-8337AB170DEB @@ -95,7 +95,7 @@ If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, t ```yaml Type: BatchAccountContext Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named @@ -127,7 +127,7 @@ If you do not specify an end time, this cmdlet uses the last aggregation interva ```yaml Type: DateTime Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -144,7 +144,7 @@ Possible operations are the following: eq, ge, gt, le, lt, startswith. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -161,7 +161,7 @@ If you do not specify a start time, this cmdlet uses the last aggregation interv ```yaml Type: DateTime Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchRemoteDesktopProtocolFile.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchRemoteDesktopProtocolFile.md index 6626adc576f3..f72e405597f8 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchRemoteDesktopProtocolFile.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchRemoteDesktopProtocolFile.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml Module Name: AzureRM.Batch ms.assetid: D077DB50-12BC-45AB-8EAC-57810DA83035 @@ -81,7 +81,7 @@ If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, t ```yaml Type: BatchAccountContext Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named @@ -97,7 +97,7 @@ To obtain a compute node object, use the Get-AzureBatchComputeNode cmdlet. ```yaml Type: PSComputeNode Parameter Sets: InputObject_Path, InputObject_Stream -Aliases: +Aliases: Required: False Position: 0 @@ -112,7 +112,7 @@ Specifies the ID of the compute node to which the .rdp file points. ```yaml Type: String Parameter Sets: Id_Path, Id_Stream -Aliases: +Aliases: Required: True Position: 1 @@ -142,7 +142,7 @@ Specifies the file path where this cmdlet saves the .rdp file. ```yaml Type: String Parameter Sets: Id_Path, InputObject_Path -Aliases: +Aliases: Required: True Position: Named @@ -158,7 +158,7 @@ This cmdlet does not close or rewind this stream. ```yaml Type: Stream Parameter Sets: Id_Stream, InputObject_Stream -Aliases: +Aliases: Required: True Position: Named @@ -173,7 +173,7 @@ Specifies the ID of the pool that contains the compute node from which this cmdl ```yaml Type: String Parameter Sets: Id_Path, Id_Stream -Aliases: +Aliases: Required: True Position: 0 diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchRemoteLoginSettings.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchRemoteLoginSettings.md index ed0961cde40f..f2a5151b06f5 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchRemoteLoginSettings.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchRemoteLoginSettings.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml Module Name: AzureRM.Batch ms.assetid: 07811B64-6A77-452C-B148-DE8C13E73DEF @@ -70,7 +70,7 @@ To obtain a **BatchAccountContext** that contains access keys for your subscript ```yaml Type: BatchAccountContext Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named @@ -86,7 +86,7 @@ To obtain a compute node object, use the Get-AzureBatchComputeNode cmdlet. ```yaml Type: PSComputeNode Parameter Sets: InputObject -Aliases: +Aliases: Required: False Position: 0 @@ -102,7 +102,7 @@ for which this cmdlet gets remote logon settings. ```yaml Type: String Parameter Sets: Id -Aliases: +Aliases: Required: True Position: 1 @@ -132,7 +132,7 @@ Specifies the ID of the pool that contains the virtual machine. ```yaml Type: String Parameter Sets: Id -Aliases: +Aliases: Required: True Position: 0 diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchSubtask.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchSubtask.md index d17411a7e4cf..ee7abadd49ca 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchSubtask.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchSubtask.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml Module Name: AzureRM.Batch ms.assetid: 7D0D8B46-4BF0-47D5-9261-3306AEB9E7DD @@ -52,7 +52,7 @@ If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, t ```yaml Type: BatchAccountContext Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named @@ -82,7 +82,7 @@ Specifies the ID of the job that contains the task whose subtasks this cmdlet ge ```yaml Type: String Parameter Sets: ODataFilter -Aliases: +Aliases: Required: True Position: 0 @@ -99,7 +99,7 @@ The default value is 1000. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -115,7 +115,7 @@ This object reference is created by using the Get-AzureBatchTask cmdlet and stor ```yaml Type: PSCloudTask Parameter Sets: ParentObject -Aliases: +Aliases: Required: False Position: 0 @@ -130,7 +130,7 @@ Specifies the ID of the task whose subtasks this cmdlet returns. ```yaml Type: String Parameter Sets: ODataFilter -Aliases: +Aliases: Required: True Position: 1 diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchTask.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchTask.md index 1922c1664b9b..2687602a076a 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchTask.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchTask.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml Module Name: AzureRM.Batch ms.assetid: 4B5FE41A-090B-4859-B021-05CF0A8B7882 @@ -121,7 +121,7 @@ If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, t ```yaml Type: BatchAccountContext Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named @@ -152,7 +152,7 @@ Specify a value for this parameter to get associated entities of the main entity ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -168,7 +168,7 @@ If you do not specify a filter, this cmdlet returns all tasks for the Batch acco ```yaml Type: String Parameter Sets: ODataFilter, ParentObject -Aliases: +Aliases: Required: False Position: Named @@ -184,7 +184,7 @@ You cannot specify wildcard characters. ```yaml Type: String Parameter Sets: Id -Aliases: +Aliases: Required: False Position: 1 @@ -200,7 +200,7 @@ To obtain a **PSCloudJob** object, use the Get-AzureBatchJob cmdlet. ```yaml Type: PSCloudJob Parameter Sets: ParentObject -Aliases: +Aliases: Required: False Position: 0 @@ -215,7 +215,7 @@ Specifies the ID of the job that contains the tasks that this cmdlet gets. ```yaml Type: String Parameter Sets: ODataFilter, Id -Aliases: +Aliases: Required: True Position: 0 @@ -232,7 +232,7 @@ The default value is 1000. ```yaml Type: Int32 Parameter Sets: ODataFilter, ParentObject -Aliases: +Aliases: Required: False Position: Named @@ -248,7 +248,7 @@ Specify a value for this parameter to get specific properties rather than all ob ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchTaskCounts.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchTaskCounts.md index f2f51231b6e7..0efe41816e2a 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchTaskCounts.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchTaskCounts.md @@ -1,5 +1,6 @@ ---- +--- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml +Module Name: AzureRM.Batch online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.batch/get-azurebatchtaskcounts schema: 2.0.0 --- @@ -14,13 +15,13 @@ Gets the task counts for the specified job. ### Id ``` Get-AzureBatchTaskCounts [-JobId] -BatchContext - [-DefaultProfile ] + [-DefaultProfile ] [] ``` ### ParentObject ``` Get-AzureBatchTaskCounts [[-Job] ] -BatchContext - [-DefaultProfile ] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -56,7 +57,7 @@ To change the key to use, set the BatchAccountContext.KeyInUse property. ```yaml Type: BatchAccountContext Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named @@ -87,7 +88,7 @@ To obtain a **PSCloudJob** object, use the Get-AzureBatchJob cmdlet. ```yaml Type: PSCloudJob Parameter Sets: ParentObject -Aliases: +Aliases: Required: False Position: 0 @@ -102,7 +103,7 @@ The id of the job for which to get task counts. ```yaml Type: String Parameter Sets: Id -Aliases: +Aliases: Required: True Position: 0 @@ -111,18 +112,19 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + ## INPUTS ### System.String Microsoft.Azure.Commands.Batch.Models.PSCloudJob Microsoft.Azure.Commands.Batch.BatchAccountContext - ## OUTPUTS ### Microsoft.Azure.Commands.Batch.Models.PSTaskCounts - ## NOTES ## RELATED LINKS diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureRmBatchAccount.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureRmBatchAccount.md index 9dc54bcf76f4..f77da6c4f5c8 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureRmBatchAccount.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureRmBatchAccount.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml Module Name: AzureRM.Batch ms.assetid: 818D5D85-B6D5-458C-A26E-E4DE8E111A10 @@ -103,7 +103,7 @@ If you specify a resource group, this cmdlet gets the accounts under the specifi ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: 1 @@ -122,7 +122,7 @@ This cmdlet gets accounts that contain the tags that this parameter specifies. ```yaml Type: Hashtable Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: 2 diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureRmBatchAccountKeys.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureRmBatchAccountKeys.md index cdab12235c54..e1453ff0ee2f 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureRmBatchAccountKeys.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureRmBatchAccountKeys.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml Module Name: AzureRM.Batch ms.assetid: AFDE5ECD-29AB-4C91-98BF-1B8C9C3BB079 @@ -66,7 +66,7 @@ Specifies the name of the resource group that contains the account for which thi ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureRmBatchApplication.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureRmBatchApplication.md index 2ec4ab70d914..8df8b3718324 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureRmBatchApplication.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureRmBatchApplication.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml Module Name: AzureRM.Batch ms.assetid: CF8B8E94-3C6C-4D68-B55B-956393890946 @@ -43,7 +43,7 @@ Specifies the name of the Batch account that contains the application. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 0 @@ -58,7 +58,7 @@ Specifies the ID of the application. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: 2 @@ -88,7 +88,7 @@ Specifies the name of the resource group that contains the Batch account. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 1 diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureRmBatchApplicationPackage.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureRmBatchApplicationPackage.md index 6a4d40f05217..acb1ce889cfd 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureRmBatchApplicationPackage.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureRmBatchApplicationPackage.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml Module Name: AzureRM.Batch ms.assetid: 17653793-3CE1-465F-87F7-20B4B8F56193 @@ -46,7 +46,7 @@ Specifies the name of the Batch account from which this cmdlet gets information. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 0 @@ -61,7 +61,7 @@ Specifies the ID of the application. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 2 @@ -76,7 +76,7 @@ Specifies the version of the application. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 3 @@ -106,7 +106,7 @@ Specifies the name of the resource group that contains the Batch account. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 1 diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureRmBatchLocationQuotas.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureRmBatchLocationQuotas.md index 8d4a7cfa297d..4932b510a95f 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureRmBatchLocationQuotas.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureRmBatchLocationQuotas.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml Module Name: AzureRM.Batch ms.assetid: A39A415A-B403-48D3-AF80-CF7CFE382577 @@ -58,7 +58,7 @@ For more information, see Azure Regions (https://azure.microsoft.com/regions). ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 0 @@ -82,4 +82,3 @@ This cmdlet does not accept any input. ## NOTES ## RELATED LINKS - diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureBatchCertificate.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureBatchCertificate.md index 8e71ef01396c..e939a98d4806 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureBatchCertificate.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureBatchCertificate.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml Module Name: AzureRM.Batch ms.assetid: B423C1A1-1988-4721-81E7-3B7EC163B03A @@ -56,7 +56,7 @@ If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, t ```yaml Type: BatchAccountContext Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named @@ -87,7 +87,7 @@ The certificate file must be in either .cer or .pfx format. ```yaml Type: String Parameter Sets: File -Aliases: +Aliases: Required: True Position: 0 @@ -103,7 +103,7 @@ You must specify this parameter if you specify a certificate in .pfx format. ```yaml Type: SecureString Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -118,7 +118,7 @@ Specifies the raw certificate data in either .cer or .pfx format. ```yaml Type: Byte[] Parameter Sets: RawData -Aliases: +Aliases: Required: True Position: 0 diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureBatchComputeNodeUser.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureBatchComputeNodeUser.md index caef24cbb06e..bb8b99c86010 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureBatchComputeNodeUser.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureBatchComputeNodeUser.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml Module Name: AzureRM.Batch ms.assetid: FE7689DE-4EC6-4C6B-94A4-D22C61CA569D @@ -60,7 +60,7 @@ If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, t ```yaml Type: BatchAccountContext Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named @@ -75,7 +75,7 @@ Specifies the compute node, as a **PSComputeNode** object, on which this cmdlet ```yaml Type: PSComputeNode Parameter Sets: ParentObject -Aliases: +Aliases: Required: False Position: 0 @@ -90,7 +90,7 @@ Specifies the ID of the compute node on which this cmdlet creates a user account ```yaml Type: String Parameter Sets: Id -Aliases: +Aliases: Required: True Position: 1 @@ -120,7 +120,7 @@ Specifies the expiry time for the new user account. ```yaml Type: DateTime Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -135,7 +135,7 @@ Indicates that the cmdlet creates a user account that has administrative credent ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -150,7 +150,7 @@ Specifies the name of the new local Windows account. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named @@ -165,7 +165,7 @@ Specifies the user account password. ```yaml Type: SecureString Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named @@ -180,7 +180,7 @@ Specifies the ID of the pool that contains the compute node on which to create t ```yaml Type: String Parameter Sets: Id -Aliases: +Aliases: Required: True Position: 0 diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureBatchJob.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureBatchJob.md index 06a86603b86c..9b03b5a9beee 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureBatchJob.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureBatchJob.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml Module Name: AzureRM.Batch ms.assetid: B6229D26-D38C-44CD-B9CA-7F39365C8B9D @@ -52,7 +52,7 @@ If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, t ```yaml Type: BatchAccountContext Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named @@ -84,7 +84,7 @@ Specifies the execution constraints for the job. ```yaml Type: PSJobConstraints Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -114,7 +114,7 @@ Specifies the display name for the job. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -129,7 +129,7 @@ Specifies an ID for the job. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 0 @@ -145,7 +145,7 @@ The Batch service runs the Job Manager task when the job is started. ```yaml Type: PSJobManagerTask Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -161,7 +161,7 @@ The Batch service runs the Job Preparation task on a compute node before it star ```yaml Type: PSJobPreparationTask Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -178,7 +178,7 @@ The Batch service runs the Job Release task on each compute node where it ran an ```yaml Type: PSJobReleaseTask Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -195,7 +195,7 @@ The value is the metadata value. ```yaml Type: IDictionary Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -210,7 +210,7 @@ Specifies an action the Batch service takes if all tasks in the job are in the c ```yaml Type: OnAllTasksComplete Parameter Sets: (All) -Aliases: +Aliases: Accepted values: NoAction, TerminateJob Required: False @@ -226,7 +226,7 @@ Specifies an action the Batch service takes if any task in the job fails. ```yaml Type: OnTaskFailure Parameter Sets: (All) -Aliases: +Aliases: Accepted values: NoAction, PerformExitOptionsJobAction Required: False @@ -242,7 +242,7 @@ Specifies the details of the pool on which the Batch service runs the tasks of t ```yaml Type: PSPoolInformation Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named @@ -261,7 +261,7 @@ The default value is 0. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -274,7 +274,7 @@ Accept wildcard characters: False ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureBatchJobSchedule.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureBatchJobSchedule.md index 324c6a334f74..dd4f5849984d 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureBatchJobSchedule.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureBatchJobSchedule.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml Module Name: AzureRM.Batch ms.assetid: 87E7FA51-427E-4DB8-A6A2-D8638FD3DB8B @@ -55,7 +55,7 @@ If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, t ```yaml Type: BatchAccountContext Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named @@ -85,7 +85,7 @@ Specifies a display name for the job schedule. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -100,7 +100,7 @@ Specifies the ID of the job schedule that this cmdlet creates. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 0 @@ -115,7 +115,7 @@ Specifies the details of the jobs that this cmdlet includes in the job schedule. ```yaml Type: PSJobSpecification Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named @@ -132,7 +132,7 @@ The value is the metadata value. ```yaml Type: IDictionary Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -147,7 +147,7 @@ Specifies the schedule that determines when to create jobs. ```yaml Type: PSSchedule Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureBatchPool.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureBatchPool.md index 9c4f37cf2fb9..27f9f5e41519 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureBatchPool.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureBatchPool.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml Module Name: AzureRM.Batch ms.assetid: C71C486E-34EB-42B5-B38A-D85B7DAA2F74 @@ -157,7 +157,7 @@ The default value is 15 minutes, and the minimum value is 5 minutes. ```yaml Type: TimeSpan Parameter Sets: CloudServiceAndAutoScale, VirtualMachineAndAutoScale -Aliases: +Aliases: Required: False Position: Named @@ -172,7 +172,7 @@ Specifies the formula for automatically scaling the pool. ```yaml Type: String Parameter Sets: CloudServiceAndAutoScale, VirtualMachineAndAutoScale -Aliases: +Aliases: Required: False Position: Named @@ -188,7 +188,7 @@ If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, t ```yaml Type: BatchAccountContext Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named @@ -219,7 +219,7 @@ Specifies configuration settings for a pool based on the Azure cloud service pla ```yaml Type: PSCloudServiceConfiguration Parameter Sets: CloudServiceAndTargetDedicated, CloudServiceAndAutoScale -Aliases: +Aliases: Required: False Position: Named @@ -249,7 +249,7 @@ Specifies the display name of the pool. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -264,7 +264,7 @@ Specifies the ID of the pool to create. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 0 @@ -279,7 +279,7 @@ Indicates that this cmdlet sets up the pool for direct communication between ded ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -294,7 +294,7 @@ Specifies the maximum number of tasks that can run on a single compute node. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -311,7 +311,7 @@ The value is the metadata value. ```yaml Type: IDictionary Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -326,7 +326,7 @@ The network configuration for the pool. ```yaml Type: PSNetworkConfiguration Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -341,7 +341,7 @@ Specifies the time-out for allocating compute nodes to the pool. ```yaml Type: TimeSpan Parameter Sets: CloudServiceAndTargetDedicated, VirtualMachineAndTargetDedicated -Aliases: +Aliases: Required: False Position: Named @@ -357,7 +357,7 @@ The start task is run when a compute node joins the pool, or when the compute no ```yaml Type: PSStartTask Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -387,7 +387,7 @@ Specifies the target number of low-priority compute nodes to allocate to the poo ```yaml Type: Int32 Parameter Sets: CloudServiceAndTargetDedicated, VirtualMachineAndTargetDedicated -Aliases: +Aliases: Required: False Position: Named @@ -402,7 +402,7 @@ Specifies the task scheduling policy, such as the ComputeNodeFillType. ```yaml Type: PSTaskSchedulingPolicy Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -417,7 +417,7 @@ The list of user accounts to be created on each node in the pool. ```yaml Type: PSUserAccount[] Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -432,7 +432,7 @@ Specifies configuration settings for a pool on the virtual machines infrastructu ```yaml Type: PSVirtualMachineConfiguration Parameter Sets: VirtualMachineAndTargetDedicated, VirtualMachineAndAutoScale -Aliases: +Aliases: Required: False Position: Named @@ -448,7 +448,7 @@ For more information about virtual machine sizes, see Sizes for virtual machines ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureBatchTask.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureBatchTask.md index 27370b35ea10..0c319681a0c4 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureBatchTask.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureBatchTask.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml Module Name: AzureRM.Batch ms.assetid: 2B4BFDDA-9721-42E6-84E1-A209CB782954 @@ -141,7 +141,7 @@ Specifies a locality hint that the Batch service uses to select a node on which ```yaml Type: PSAffinityInformation Parameter Sets: JobId_Single, JobObject_Single -Aliases: +Aliases: Required: False Position: Named @@ -175,7 +175,7 @@ or check the status of the job or of other tasks. ```yaml Type: PSAuthenticationTokenSettings Parameter Sets: JobId_Single, JobObject_Single -Aliases: +Aliases: Required: False Position: Named @@ -191,7 +191,7 @@ If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, t ```yaml Type: BatchAccountContext Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named @@ -206,7 +206,7 @@ Specifies the command line for the task. ```yaml Type: String Parameter Sets: JobId_Single, JobObject_Single -Aliases: +Aliases: Required: False Position: Named @@ -221,7 +221,7 @@ Specifies the execution constraints that apply to this task. ```yaml Type: PSTaskConstraints Parameter Sets: JobId_Single, JobObject_Single -Aliases: +Aliases: Required: False Position: Named @@ -241,7 +241,7 @@ are mapped into the container, and the task command line is executed in the cont ```yaml Type: PSTaskContainerSettings Parameter Sets: JobId_Single, JobObject_Single -Aliases: +Aliases: Required: False Position: Named @@ -272,7 +272,7 @@ The task will not be scheduled until all depended-on tasks have completed succes ```yaml Type: TaskDependencies Parameter Sets: JobId_Single, JobObject_Single -Aliases: +Aliases: Required: False Position: Named @@ -287,7 +287,7 @@ Specifies the display name of the task. ```yaml Type: String Parameter Sets: JobId_Single, JobObject_Single -Aliases: +Aliases: Required: False Position: Named @@ -317,7 +317,7 @@ Accept wildcard characters: False ```yaml Type: PSExitConditions Parameter Sets: JobId_Single, JobObject_Single -Aliases: +Aliases: Required: False Position: Named @@ -332,7 +332,7 @@ Specifies the ID of the task. ```yaml Type: String Parameter Sets: JobId_Single, JobObject_Single -Aliases: +Aliases: Required: True Position: Named @@ -348,7 +348,7 @@ To obtain a **PSCloudJob** object, use the Get-AzureBatchJob cmdlet. ```yaml Type: PSCloudJob Parameter Sets: JobObject_Bulk, JobObject_Single -Aliases: +Aliases: Required: False Position: Named @@ -363,7 +363,7 @@ Specifies the ID of the job under which this cmdlet creates the task. ```yaml Type: String Parameter Sets: JobId_Single, JobId_Bulk -Aliases: +Aliases: Required: True Position: Named @@ -378,7 +378,7 @@ Specifies information about how to run a multi-instance task. ```yaml Type: PSMultiInstanceSettings Parameter Sets: JobId_Single, JobObject_Single -Aliases: +Aliases: Required: False Position: Named @@ -395,7 +395,7 @@ For multi-instance tasks, the files will only be uploaded from the compute node ```yaml Type: PSOutputFile[] Parameter Sets: JobId_Single, JobObject_Single -Aliases: +Aliases: Required: False Position: Named @@ -428,7 +428,7 @@ Each task must have a unique ID. ```yaml Type: PSCloudTask[] Parameter Sets: JobId_Bulk, JobObject_Bulk -Aliases: +Aliases: Required: False Position: Named @@ -443,7 +443,7 @@ The user identity under which the task runs. ```yaml Type: PSUserIdentity Parameter Sets: JobId_Single, JobObject_Single -Aliases: +Aliases: Required: False Position: Named diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureRmBatchAccount.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureRmBatchAccount.md index 6beddf3f26fa..4100093189af 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureRmBatchAccount.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureRmBatchAccount.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml Module Name: AzureRM.Batch ms.assetid: 82C7B128-8818-4390-B1A5-CB40AC9D53CA @@ -64,7 +64,7 @@ Specifies the resource ID of the storage account to be used for auto storage. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: 3 @@ -94,7 +94,7 @@ The resource ID of the Azure key vault associated with the Batch account. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -109,7 +109,7 @@ The URL of the Azure key vault associated with the Batch account. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -125,7 +125,7 @@ For more information, see [Azure Regions](https://azure.microsoft.com/en-us/regi ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 1 @@ -140,7 +140,7 @@ The allocation mode for creating pools in the Batch account. ```yaml Type: PoolAllocationMode Parameter Sets: (All) -Aliases: +Aliases: Accepted values: BatchService, UserSubscription Required: False @@ -156,7 +156,7 @@ Specifies the name of the resource group in which this cmdlet creates the accoun ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 2 diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureRmBatchAccountKey.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureRmBatchAccountKey.md index 0f2b30b2e52b..276c50b1afb9 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureRmBatchAccountKey.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureRmBatchAccountKey.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml Module Name: AzureRM.Batch ms.assetid: 486748AC-3932-4E0C-BBCC-2BC194E69DCC @@ -87,7 +87,7 @@ Valid values are: ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Accepted values: Primary, Secondary Required: True @@ -103,7 +103,7 @@ Specifies the resource group of the account for which this cmdlet regenerates a ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureRmBatchApplication.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureRmBatchApplication.md index caa99942af71..0706712212d5 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureRmBatchApplication.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureRmBatchApplication.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml Module Name: AzureRM.Batch ms.assetid: FF111B74-90A3-4F7C-B515-CE1EEF68EB54 @@ -40,7 +40,7 @@ Specifies the name of the Batch account to which this cmdlet adds an application ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 0 @@ -55,7 +55,7 @@ Specifies whether packages within the application can be overwritten using the s ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: 3 @@ -70,7 +70,7 @@ Specifies the ID of the application. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 2 @@ -100,7 +100,7 @@ Specifies the display name for the application. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: 4 @@ -115,7 +115,7 @@ Specifies the name of the resource group that contains the Batch account. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 1 diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureRmBatchApplicationPackage.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureRmBatchApplicationPackage.md index 1852f477ee98..784645437552 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureRmBatchApplicationPackage.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureRmBatchApplicationPackage.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml Module Name: AzureRM.Batch ms.assetid: D53DAEB6-DC4F-473C-A193-A1E2A65326D4 @@ -47,7 +47,7 @@ Specifies the name of the Batch account to which this cmdlet adds an application ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 0 @@ -62,7 +62,7 @@ Indicates that this cmdlet activates an application package that has already bee ```yaml Type: SwitchParameter Parameter Sets: ActivateOnly -Aliases: +Aliases: Required: False Position: Named @@ -77,7 +77,7 @@ Specifies the ID of the application. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 2 @@ -92,7 +92,7 @@ Specifies the version of the application. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 3 @@ -122,7 +122,7 @@ Specifies the file to be uploaded as the application package binary file. ```yaml Type: String Parameter Sets: UploadAndActivate -Aliases: +Aliases: Required: True Position: Named @@ -137,7 +137,7 @@ Specifies the format of the application package binary file. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 4 @@ -152,7 +152,7 @@ Specifies the name of the resource group that contains the Batch account. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 1 diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureBatchCertificate.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureBatchCertificate.md index 15cc34f21372..70a759541769 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureBatchCertificate.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureBatchCertificate.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml Module Name: AzureRM.Batch ms.assetid: 3DFFD0F2-6CD8-4FBE-B15C-8505CBF8F44E @@ -51,7 +51,7 @@ If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, t ```yaml Type: BatchAccountContext Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named @@ -81,7 +81,7 @@ Specifies the thumbprint of the certificate that this cmdlet deletes. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 1 @@ -97,7 +97,7 @@ Currently, the only valid value is sha1. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 0 diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureBatchComputeNode.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureBatchComputeNode.md index 146367d601ce..89af37aca916 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureBatchComputeNode.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureBatchComputeNode.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml Module Name: AzureRM.Batch ms.assetid: 0BB79553-26DA-413C-8086-740DB6B31A85 @@ -71,7 +71,7 @@ If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, t ```yaml Type: BatchAccountContext Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named @@ -86,7 +86,7 @@ Specifies the **PSComputeNode** object that represents the compute node that thi ```yaml Type: PSComputeNode Parameter Sets: InputObject -Aliases: +Aliases: Required: False Position: 0 @@ -102,7 +102,7 @@ The default value is Requeue. ```yaml Type: ComputeNodeDeallocationOption Parameter Sets: (All) -Aliases: +Aliases: Accepted values: Requeue, Terminate, TaskCompletion, RetainedData Required: False @@ -133,7 +133,7 @@ Forces the command to run without asking for user confirmation. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -163,7 +163,7 @@ Specifies the ID of the pool that contains the compute nodes that this cmdlet re ```yaml Type: String Parameter Sets: Id -Aliases: +Aliases: Required: True Position: 0 @@ -180,7 +180,7 @@ The minimum value is 5 minutes. ```yaml Type: TimeSpan Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureBatchComputeNodeUser.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureBatchComputeNodeUser.md index 36d07f55a35c..80900d532992 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureBatchComputeNodeUser.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureBatchComputeNodeUser.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml Module Name: AzureRM.Batch ms.assetid: 9E423A10-06AF-42F8-AC90-82DB01012AFA @@ -43,7 +43,7 @@ If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, t ```yaml Type: BatchAccountContext Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named @@ -58,7 +58,7 @@ Specifies the ID of the compute node on which this cmdlet deletes the user accou ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 1 @@ -89,7 +89,7 @@ You cannot specify wildcard characters. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 2 @@ -104,7 +104,7 @@ Specifies the ID of the pool that contains the compute node on which to delete t ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 0 diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureBatchJob.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureBatchJob.md index 241c36c0e600..15d90a80f06d 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureBatchJob.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureBatchJob.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml Module Name: AzureRM.Batch ms.assetid: CB2F472B-C792-4A11-A055-F4161DCFBB28 @@ -52,7 +52,7 @@ If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, t ```yaml Type: BatchAccountContext Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named @@ -82,7 +82,7 @@ Forces the command to run without asking for user confirmation. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -98,7 +98,7 @@ You cannot specify wildcard characters. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 0 diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureBatchJobSchedule.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureBatchJobSchedule.md index cfe30f9af3a1..4002a4f90de1 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureBatchJobSchedule.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureBatchJobSchedule.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml Module Name: AzureRM.Batch ms.assetid: 97FA5983-0D73-4336-99DA-46E5992F06DC @@ -37,7 +37,7 @@ If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, t ```yaml Type: BatchAccountContext Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named @@ -67,7 +67,7 @@ Forces the command to run without asking for user confirmation. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -82,7 +82,7 @@ Specifies the ID of the job schedule to remove. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 0 diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureBatchNodeFile.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureBatchNodeFile.md index 458c1501f9c1..f9ed407f694c 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureBatchNodeFile.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureBatchNodeFile.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml Module Name: AzureRM.Batch ms.assetid: DBA02017-8372-4A91-A4F1-985777DEDAB9 @@ -75,7 +75,7 @@ If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, t ```yaml Type: BatchAccountContext Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named @@ -90,7 +90,7 @@ Specifies the ID of the compute node that contains the Batch node file that this ```yaml Type: String Parameter Sets: ComputeNode -Aliases: +Aliases: Required: True Position: 1 @@ -120,7 +120,7 @@ Forces the command to run without asking for user confirmation. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -136,7 +136,7 @@ To obtain a **PSNodeFile**, use the Get-AzureBatchNodeFile cmdlet. ```yaml Type: PSNodeFile Parameter Sets: InputObject -Aliases: +Aliases: Required: False Position: 0 @@ -151,7 +151,7 @@ Specifies the ID of the job that contains the task. ```yaml Type: String Parameter Sets: Task -Aliases: +Aliases: Required: True Position: Named @@ -181,7 +181,7 @@ Specifies the ID of the pool that contains the compute nodes for which this cmdl ```yaml Type: String Parameter Sets: ComputeNode -Aliases: +Aliases: Required: True Position: 0 @@ -197,7 +197,7 @@ This cmdlet is relevant only if the path is a folder. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -212,7 +212,7 @@ Specifies the ID of the task. ```yaml Type: String Parameter Sets: Task -Aliases: +Aliases: Required: True Position: Named diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureBatchPool.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureBatchPool.md index fca92ab1e042..5f788ca73dfb 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureBatchPool.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureBatchPool.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml Module Name: AzureRM.Batch ms.assetid: DB0A8E4B-AD3F-4BAC-A0B2-031913E019D4 @@ -49,7 +49,7 @@ If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, t ```yaml Type: BatchAccountContext Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named @@ -79,7 +79,7 @@ Forces the command to run without asking for user confirmation. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -95,7 +95,7 @@ You cannot specify wildcard characters. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 0 diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureBatchTask.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureBatchTask.md index 21c10d194362..05f50d309d51 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureBatchTask.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureBatchTask.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml Module Name: AzureRM.Batch ms.assetid: D79AEF8C-F0DC-40F8-9EEE-A2BB6AE5C4BF @@ -60,7 +60,7 @@ If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, t ```yaml Type: BatchAccountContext Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named @@ -90,7 +90,7 @@ Forces the command to run without asking for user confirmation. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -106,7 +106,7 @@ You cannot specify wildcard characters. ```yaml Type: String Parameter Sets: Id -Aliases: +Aliases: Required: True Position: 1 @@ -122,7 +122,7 @@ To obtain a **PSCloudTask** object, use the Get-AzureBatchTask cmdlet. ```yaml Type: PSCloudTask Parameter Sets: InputObject -Aliases: +Aliases: Required: True Position: 0 @@ -137,7 +137,7 @@ Specifies the ID of the job that contains the task. ```yaml Type: String Parameter Sets: Id -Aliases: +Aliases: Required: True Position: 0 diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureRmBatchAccount.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureRmBatchAccount.md index a65feb95bab2..d148670be8cd 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureRmBatchAccount.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureRmBatchAccount.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml Module Name: AzureRM.Batch ms.assetid: 89F604DD-EE77-440D-BCC9-3F74D994C447 @@ -70,7 +70,7 @@ Forces the command to run without asking for user confirmation. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -85,7 +85,7 @@ Specifies the resource group of the account that this cmdlet removes. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: 1 diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureRmBatchApplication.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureRmBatchApplication.md index 26a7fd600eb8..c420f586afce 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureRmBatchApplication.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureRmBatchApplication.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml Module Name: AzureRM.Batch ms.assetid: 2CED21D6-4BEF-423B-A04A-5B812CEB975D @@ -39,7 +39,7 @@ Specifies the name of the Batch account from which this cmdlet removes an applic ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 0 @@ -54,7 +54,7 @@ Specifies the ID of the application. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 2 @@ -84,7 +84,7 @@ Specifies the name of the resource group that contains the Batch account. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 1 diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureRmBatchApplicationPackage.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureRmBatchApplicationPackage.md index fbe014a7b380..9f7754b47fe8 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureRmBatchApplicationPackage.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureRmBatchApplicationPackage.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml Module Name: AzureRM.Batch ms.assetid: FD2E3442-9CEA-4390-BE9C-772C7D6FD1E2 @@ -40,7 +40,7 @@ Specifies the name of the Batch account from which this cmdlet deletes an applic ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 0 @@ -55,7 +55,7 @@ Specifies the ID of the application. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 2 @@ -70,7 +70,7 @@ Specifies the version of the application. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 3 @@ -100,7 +100,7 @@ Specifies the name of the resource group that contains the Batch account. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 1 diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Reset-AzureBatchComputeNode.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Reset-AzureBatchComputeNode.md index 9fb96807d004..4d586f7627cd 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Reset-AzureBatchComputeNode.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Reset-AzureBatchComputeNode.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml Module Name: AzureRM.Batch ms.assetid: A202537B-D292-4822-A0B9-27A6A20621D4 @@ -54,7 +54,7 @@ If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, t ```yaml Type: BatchAccountContext Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named @@ -69,7 +69,7 @@ Specifies the **PSComputeNode** object that represents the compute node to reima ```yaml Type: PSComputeNode Parameter Sets: InputObject -Aliases: +Aliases: Required: False Position: 0 @@ -99,7 +99,7 @@ Specifies the ID of the compute node to reimage. ```yaml Type: String Parameter Sets: Id -Aliases: +Aliases: Required: True Position: 1 @@ -114,7 +114,7 @@ Specifies the ID of the pool that contains the compute node. ```yaml Type: String Parameter Sets: Id -Aliases: +Aliases: Required: True Position: 0 @@ -130,7 +130,7 @@ The default is Requeue. ```yaml Type: ComputeNodeReimageOption Parameter Sets: (All) -Aliases: +Aliases: Accepted values: Requeue, Terminate, TaskCompletion, RetainedData Required: False diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Restart-AzureBatchComputeNode.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Restart-AzureBatchComputeNode.md index 548ede9dc2ca..56ddb62971cc 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Restart-AzureBatchComputeNode.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Restart-AzureBatchComputeNode.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml Module Name: AzureRM.Batch ms.assetid: 029361F0-C4E9-4948-9EBA-BFBD1B029909 @@ -53,7 +53,7 @@ If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, t ```yaml Type: BatchAccountContext Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named @@ -68,7 +68,7 @@ Specifies the **PSComputeNode** object that represents the compute node to reboo ```yaml Type: PSComputeNode Parameter Sets: InputObject -Aliases: +Aliases: Required: False Position: 0 @@ -98,7 +98,7 @@ Specifies the ID of the compute node to reboot. ```yaml Type: String Parameter Sets: Id -Aliases: +Aliases: Required: True Position: 1 @@ -113,7 +113,7 @@ Specifies the ID of the pool that contains the compute node. ```yaml Type: String Parameter Sets: Id -Aliases: +Aliases: Required: True Position: 0 @@ -129,7 +129,7 @@ The default is Requeue. ```yaml Type: ComputeNodeRebootOption Parameter Sets: (All) -Aliases: +Aliases: Accepted values: Requeue, Terminate, TaskCompletion, RetainedData Required: False diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Set-AzureBatchComputeNodeUser.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Set-AzureBatchComputeNodeUser.md index e9a4cf4b9d71..81b1e62d45cf 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Set-AzureBatchComputeNodeUser.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Set-AzureBatchComputeNodeUser.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml Module Name: AzureRM.Batch ms.assetid: A0D620DA-B5A3-4F8F-BD43-A58630C95432 @@ -41,7 +41,7 @@ If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, t ```yaml Type: BatchAccountContext Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named @@ -56,7 +56,7 @@ Specifies the ID of the compute node on which this cmdlet operates. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 1 @@ -86,7 +86,7 @@ Specifies the expiry time for the user account. ```yaml Type: DateTime Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -101,7 +101,7 @@ Specifies the name of the user account that this cmdlet modifies. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 2 @@ -116,7 +116,7 @@ Specifies the password for the user account. ```yaml Type: SecureString Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 3 @@ -131,7 +131,7 @@ Specifies the ID of the pool that contains the compute node on which this cmdlet ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 0 diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Set-AzureBatchJob.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Set-AzureBatchJob.md index 81eed933955c..275709426a31 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Set-AzureBatchJob.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Set-AzureBatchJob.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml Module Name: AzureRM.Batch ms.assetid: 75483BC7-440A-437B-9EDE-D270D87CF3C5 @@ -47,7 +47,7 @@ If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, t ```yaml Type: BatchAccountContext Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named @@ -77,7 +77,7 @@ Specifies a **PSCloudJob** to which this cmdlet updates the Batch service. ```yaml Type: PSCloudJob Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 0 diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Set-AzureBatchJobSchedule.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Set-AzureBatchJobSchedule.md index 4ce637ecde7c..7c2feef8fb51 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Set-AzureBatchJobSchedule.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Set-AzureBatchJobSchedule.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml Module Name: AzureRM.Batch ms.assetid: 14026F0E-4959-4150-A31F-A94BC56ED808 @@ -37,7 +37,7 @@ If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, t ```yaml Type: BatchAccountContext Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named @@ -68,7 +68,7 @@ To obtain a **PSCloudJobSchedule** object, use the Get-AzureBatchJobSchedule cmd ```yaml Type: PSCloudJobSchedule Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 0 diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Set-AzureBatchPool.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Set-AzureBatchPool.md index 7610469ffc52..da4b21b2b0cb 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Set-AzureBatchPool.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Set-AzureBatchPool.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml Module Name: AzureRM.Batch ms.assetid: 23893EAE-47F3-45AA-AEB2-354FB8316C25 @@ -49,7 +49,7 @@ If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, t ```yaml Type: BatchAccountContext Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named @@ -79,7 +79,7 @@ Specifies the **PSCloudPool** to which this cmdlet updates the Batch service. ```yaml Type: PSCloudPool Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 0 diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Set-AzureBatchPoolOSVersion.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Set-AzureBatchPoolOSVersion.md index de4ca911d65e..631c90ceb92f 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Set-AzureBatchPoolOSVersion.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Set-AzureBatchPoolOSVersion.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml Module Name: AzureRM.Batch ms.assetid: 4C3C6C81-7486-4ED6-BA30-2F202E654F77 @@ -39,7 +39,7 @@ If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, t ```yaml Type: BatchAccountContext Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named @@ -69,7 +69,7 @@ Specifies the ID of the pool. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 0 @@ -85,7 +85,7 @@ For more information on Azure Guest operating system versions, see Azure Guest O ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 1 diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Set-AzureBatchTask.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Set-AzureBatchTask.md index 5edcf271449f..696244d6cf43 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Set-AzureBatchTask.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Set-AzureBatchTask.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml Module Name: AzureRM.Batch ms.assetid: 6A6D6C7D-EED7-4AD4-ACE6-BFA64404455E @@ -48,7 +48,7 @@ If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, t ```yaml Type: BatchAccountContext Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named @@ -78,7 +78,7 @@ Specifies the **PSCloudTask** to which this cmdlet updates the Batch service. ```yaml Type: PSCloudTask Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 0 diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Set-AzureRmBatchAccount.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Set-AzureRmBatchAccount.md index 08b0ac82fdf8..73e71b719907 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Set-AzureRmBatchAccount.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Set-AzureRmBatchAccount.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml Module Name: AzureRM.Batch ms.assetid: 9BEE5888-304D-4438-BE97-D1FE254AEE98 @@ -67,7 +67,7 @@ Specifies the resource ID of the storage account to be used for auto storage. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -97,7 +97,7 @@ Specifies the resource group of the account that this cmdlet updates. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Set-AzureRmBatchApplication.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Set-AzureRmBatchApplication.md index 5e05b55cefd4..6e2a3e28feed 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Set-AzureRmBatchApplication.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Set-AzureRmBatchApplication.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml Module Name: AzureRM.Batch ms.assetid: DCA1FD7A-54AF-48B1-A245-BFA9C43ACA9B @@ -40,7 +40,7 @@ Specifies the name of the Batch account for which this cmdlet modifies an applic ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 0 @@ -55,7 +55,7 @@ Specifies whether packages within the application can be overwritten using the s ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: 5 @@ -70,7 +70,7 @@ Specifies the ID of the application. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 2 @@ -100,7 +100,7 @@ Specifies which package to use if a client requests the application but does not ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: 4 @@ -115,7 +115,7 @@ Specifies the display name for the application. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: 3 @@ -130,7 +130,7 @@ Specifies the name of the resource group that contains the Batch account. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 1 diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Start-AzureBatchComputeNodeServiceLogUpload.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Start-AzureBatchComputeNodeServiceLogUpload.md new file mode 100644 index 000000000000..25f2ae832751 --- /dev/null +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Start-AzureBatchComputeNodeServiceLogUpload.md @@ -0,0 +1,259 @@ +--- +external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml +Module Name: AzureRM.Batch +online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.batch/Start-AzureBatchComputeNodeServiceLogUpload +schema: 2.0.0 +--- + +# Start-AzureBatchComputeNodeServiceLogUpload + +## SYNOPSIS +Upload compute node service log files to an Azure Storage container. + +## SYNTAX + +### AzureBatchComputeNodeServiceLogUpload (Default) +``` +Start-AzureBatchComputeNodeServiceLogUpload [-ContainerUrl] [-StartTime] + [[-EndTime] ] -BatchContext [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +### Id +``` +Start-AzureBatchComputeNodeServiceLogUpload [-PoolId] [-ComputeNodeId] + [-ContainerUrl] [-StartTime] [[-EndTime] ] -BatchContext + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### ParentObject +``` +Start-AzureBatchComputeNodeServiceLogUpload [-ComputeNode] [-ContainerUrl] + [-StartTime] [[-EndTime] ] -BatchContext + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +This cmdlet gathers Azure Batch service log files 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. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> $storageContext = New-AzureStorageContext -StorageAccountName "contosogeneral" -StorageAccountKey "" +PS C:\> $sasToken = New-AzureStorageContainerSASToken -Name "contosocontainer" -Context $storageContext +PS C:\> $containerUrl = "https://contosogeneral.blob.core.windows.net/contosocontainer" + $sasToken +PS C:\> $batchContext = Get-AzureRmBatchAccountKeys -AccountName "contosobatch" +PS C:\> Start-AzureBatchComputeNodeServiceLogUpload -BatchContext $batchContext -PoolId "contosopool" -ComputeNodeId "tvm-1612030122_1-20180405t234700z" -ContainerUrl $containerUrl -StartTime "2018-01-01 00:00:00Z" + +NumberOfFilesUploaded VirtualDirectoryName +--------------------- -------------------- + 4 contosobatch-22F48D278AD60CC2/contosopool/tvm-1612030122_1-20180405t234700z/bc3dd583-19a5-4665-aa83-87e4e1237d35 +``` + +Upload compute node service logs written on or after January 1, 2018 midnight, which were obtained from the compute node, given pool id of the pool in which the compute node resides, and compute node id. + +### Example 2 + +```powershell +PS C:\> $storageContext = New-AzureStorageContext -StorageAccountName "contosogeneral" -StorageAccountKey "" +PS C:\> $sasToken = New-AzureStorageContainerSASToken -Name "contosocontainer" -Context $storageContext +PS C:\> $containerUrl = "https://contosogeneral.blob.core.windows.net/contosocontainer" + $sasToken +PS C:\> $batchContext = Get-AzureRmBatchAccountKeys -AccountName "contosobatch" +PS C:\> Start-AzureBatchComputeNodeServiceLogUpload -BatchContext $batchContext -PoolId "contosopool" -ComputeNodeId "tvm-1612030122_1-20180405t234700z" -ContainerUrl $containerUrl -StartTime "2018-01-01 00:00:00Z" -EndTime "2018-01-10 00:00:00Z" + +NumberOfFilesUploaded VirtualDirectoryName +--------------------- -------------------- + 2 contosobatch-22F48D278AD60CC2/contosopool/tvm-1612030122_1-20180405t234700z/bc3dd583-19a5-4665-aa83-87e4e1237d35 +``` + +Upload compute node service logs written on or after January 1, 2018 midnight and before January 10, 2018 midnight, which were obtained from the compute node, given pool id of the pool in which the compute node resides, and compute node id. + +### Example 3 + +```powershell +PS C:\> $storageContext = New-AzureStorageContext -StorageAccountName "contosogeneral" -StorageAccountKey "" +PS C:\> $sasToken = New-AzureStorageContainerSASToken -Name "contosocontainer" -Context $storageContext +PS C:\> $containerUrl = "https://contosogeneral.blob.core.windows.net/contosocontainer" + $sasToken +PS C:\> $batchContext = Get-AzureRmBatchAccountKeys -AccountName "contosobatch" +PS C:\> Get-AzureBatchComputeNode -BatchContext $batchContext -Id "tvm-1612030122_1-20180405t234700z" -PoolId "contosopool" | Start-AzureBatchComputeNodeServiceLogUpload -BatchContext $batchContext -ContainerUrl $containerUrl -StartTime "2018-01-01 00:00:00Z" -EndTime "2018-01-10 00:00:00Z" + +NumberOfFilesUploaded VirtualDirectoryName +--------------------- -------------------- + 2 contosobatch-22F48D278AD60CC2/contosopool/tvm-1612030122_1-20180405t234700z/bc3dd583-19a5-4665-aa83-87e4e1237d35 +``` + +Upload compute node service logs written on or after January 1, 2018 midnight and before January 10, 2018 midnight, which were obtained from the compute node object. + +## PARAMETERS + +### -BatchContext +The BatchAccountContext instance to use when interacting with the Batch service. +If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, then Azure Active Directory authentication will be used when interacting with the Batch service. +To use shared key authentication instead, use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated. +When using shared key authentication, the primary access key is used by default. +To change the key to use, set the BatchAccountContext.KeyInUse property. + +```yaml +Type: BatchAccountContext +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ComputeNode +Specifies the **PSComputeNode** object from which service logs are retrieved. + +```yaml +Type: PSComputeNode +Parameter Sets: ParentObject +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ComputeNodeId +The id of the compute node. + +```yaml +Type: String +Parameter Sets: Id +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContainerUrl +The container url to Azure Storage. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndTime +The end time of service log to be uploaded (optional). + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PoolId +The id of the pool that contains the compute node. + +```yaml +Type: String +Parameter Sets: Id +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartTime +The start time of service log to be uploaded. + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.Commands.Batch.Models.PSComputeNode +Microsoft.Azure.Commands.Batch.BatchAccountContext + +## OUTPUTS + +### Microsoft.Azure.Commands.Batch.Models.PSStartComputeNodeServiceLogUploadResult + +## NOTES + +## RELATED LINKS diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Start-AzureBatchPoolResize.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Start-AzureBatchPoolResize.md index 960155e919b8..fbf4197222ab 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Start-AzureBatchPoolResize.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Start-AzureBatchPoolResize.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml Module Name: AzureRM.Batch ms.assetid: 82DC8DC4-D8EC-4847-A54C-B779256FD590 @@ -56,7 +56,7 @@ If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, t ```yaml Type: BatchAccountContext Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named @@ -71,7 +71,7 @@ Specifies a deallocation option for the resizing operation that this cmdlet star ```yaml Type: ComputeNodeDeallocationOption Parameter Sets: (All) -Aliases: +Aliases: Accepted values: Requeue, Terminate, TaskCompletion, RetainedData Required: False @@ -102,7 +102,7 @@ Specifies the ID of the pool that this cmdlet resizes. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 0 @@ -118,7 +118,7 @@ If the pool does not reach the target size by this time, the resize operation st ```yaml Type: TimeSpan Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -148,7 +148,7 @@ The number of target low-priority compute nodes. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Stop-AzureBatchCertificateDeletion.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Stop-AzureBatchCertificateDeletion.md index c784d286e4a6..e1200d8bad03 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Stop-AzureBatchCertificateDeletion.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Stop-AzureBatchCertificateDeletion.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml Module Name: AzureRM.Batch ms.assetid: B3C8A2DB-6571-418D-8C4B-3BE3FDA42F89 @@ -41,7 +41,7 @@ If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, t ```yaml Type: BatchAccountContext Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named @@ -71,7 +71,7 @@ Specifies the thumbprint of the certificate that this cmdlet restores to the **A ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 1 @@ -87,7 +87,7 @@ Currently, the only valid value is sha1. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 0 diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Stop-AzureBatchJob.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Stop-AzureBatchJob.md index 2216df2b82fc..4e9400bf6cf8 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Stop-AzureBatchJob.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Stop-AzureBatchJob.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml Module Name: AzureRM.Batch ms.assetid: 975B707C-5001-43ED-81AB-9BB6665135BA @@ -42,7 +42,7 @@ If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, t ```yaml Type: BatchAccountContext Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named @@ -72,7 +72,7 @@ Specifies the ID of the job that this cmdlet stops. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 0 @@ -88,7 +88,7 @@ This cmdlet stores this text as the **TerminateReason** property of the job. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: 1 diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Stop-AzureBatchJobSchedule.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Stop-AzureBatchJobSchedule.md index 0be21dcb000c..b03f3cdb095d 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Stop-AzureBatchJobSchedule.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Stop-AzureBatchJobSchedule.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml Module Name: AzureRM.Batch ms.assetid: D1C5B35C-5419-4739-9D57-6C4228E98DAC @@ -40,7 +40,7 @@ If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, t ```yaml Type: BatchAccountContext Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named @@ -70,7 +70,7 @@ Specifies the ID of the job schedule that this cmdlet stops. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 0 diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Stop-AzureBatchPoolResize.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Stop-AzureBatchPoolResize.md index a3f17fcf4413..138c657e68f0 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Stop-AzureBatchPoolResize.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Stop-AzureBatchPoolResize.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml Module Name: AzureRM.Batch ms.assetid: 3E736E85-0488-4D10-BEA1-4F9B8DA54C4B @@ -50,7 +50,7 @@ If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, t ```yaml Type: BatchAccountContext Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named @@ -80,7 +80,7 @@ Specifies the ID of the pool for which this cmdlet stops a resizing operation. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 0 diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Stop-AzureBatchTask.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Stop-AzureBatchTask.md index f32bd07af7c2..b601f1b2d96b 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Stop-AzureBatchTask.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Stop-AzureBatchTask.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml Module Name: AzureRM.Batch ms.assetid: 1EA57372-6FA5-45C9-94A1-50D53830FC10 @@ -57,7 +57,7 @@ If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, t ```yaml Type: BatchAccountContext Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named @@ -87,7 +87,7 @@ Specifies the ID of the task that this cmdlet stops. ```yaml Type: String Parameter Sets: Id -Aliases: +Aliases: Required: True Position: 1 @@ -102,7 +102,7 @@ Specifies the ID of the job that contains the task. ```yaml Type: String Parameter Sets: Id -Aliases: +Aliases: Required: True Position: 0 @@ -118,7 +118,7 @@ To obtain a **PSCloudTask** object, use the Get-AzureBatchTask cmdlet. ```yaml Type: PSCloudTask Parameter Sets: InputObject -Aliases: +Aliases: Required: True Position: 0 diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Test-AzureBatchAutoScale.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Test-AzureBatchAutoScale.md index d0600998acb9..1fb8c077d014 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Test-AzureBatchAutoScale.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Test-AzureBatchAutoScale.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml Module Name: AzureRM.Batch ms.assetid: BF0C1A2F-2703-492F-A3A7-053416A5D1EB @@ -45,7 +45,7 @@ Specifies the formula for the desired number of compute nodes in the pool. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 1 @@ -61,7 +61,7 @@ If you use the Get-AzureRmBatchAccount cmdlet to get your BatchAccountContext, t ```yaml Type: BatchAccountContext Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named @@ -91,7 +91,7 @@ Specifies the object ID of the pool for which to test automatic scaling. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 0 diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/packages.config b/src/ResourceManager/AzureBatch/Commands.Batch/packages.config index d3d433871c2d..2fd38774db0c 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/packages.config +++ b/src/ResourceManager/AzureBatch/Commands.Batch/packages.config @@ -1,6 +1,6 @@  - + diff --git a/tools/StaticAnalysis/Exceptions/SignatureIssues.csv b/tools/StaticAnalysis/Exceptions/SignatureIssues.csv index 529c049d0ee4..2b3c9e1db546 100644 --- a/tools/StaticAnalysis/Exceptions/SignatureIssues.csv +++ b/tools/StaticAnalysis/Exceptions/SignatureIssues.csv @@ -189,6 +189,7 @@ "Microsoft.Azure.Commands.Batch.dll","Microsoft.Azure.Commands.Batch.NewBatchTaskCommand","New-AzureBatchTask","1","8410","Parameter ApplicationPackageReferences of cmdlet New-AzureBatchTask does not follow the enforced naming convention of using a singular noun for a parameter name.","Consider using a singular noun for the parameter name." "Microsoft.Azure.Commands.Batch.dll","Microsoft.Azure.Commands.Batch.NewBatchTaskCommand","New-AzureBatchTask","1","8410","Parameter Tasks of cmdlet New-AzureBatchTask does not follow the enforced naming convention of using a singular noun for a parameter name.","Consider using a singular noun for the parameter name." "Microsoft.Azure.Commands.Batch.dll","Microsoft.Azure.Commands.Batch.NewBatchTaskCommand","New-AzureBatchTask","1","8410","Parameter ExitConditions of cmdlet New-AzureBatchTask does not follow the enforced naming convention of using a singular noun for a parameter name.","Consider using a singular noun for the parameter name." +"Microsoft.Azure.Commands.Batch.dll","Microsoft.Azure.Commands.Batch.GetBatchPoolNodeCountsCommand","Get-AzureBatchPoolNodeCounts","1","8400","Get-AzureBatchPoolNodeCounts uses the noun 'AzureBatchPoolNodeCounts', which does not follow the enforced naming convention of using a singular noun for a cmdlet name.","Consider using a singular noun for the cmdlet name." "Microsoft.Azure.Commands.Cdn.dll","Microsoft.Azure.Commands.Cdn.Origin.SetAzureRmCdnOrigin","Set-AzureRmCdnOrigin","1","8100","Set-AzureRmCdnOrigin Does not support ShouldProcess but the cmdlet verb Set indicates that it should.","Determine if the cmdlet should implement ShouldProcess and if so determine if it should implement Force / ShouldContinue" "Microsoft.Azure.Commands.Cdn.dll","Microsoft.Azure.Commands.Cdn.Endpoint.PublishAzureRmCdnEndpointContent","Publish-AzureRmCdnEndpointContent","1","8100","Publish-AzureRmCdnEndpointContent Does not support ShouldProcess but the cmdlet verb Publish indicates that it should.","Determine if the cmdlet should implement ShouldProcess and if so determine if it should implement Force / ShouldContinue" "Microsoft.Azure.Commands.Cdn.dll","Microsoft.Azure.Commands.Cdn.Profile.NewAzureRmCdnProfile","New-AzureRmCdnProfile","1","8410","Parameter Tags of cmdlet New-AzureRmCdnProfile does not follow the enforced naming convention of using a singular noun for a parameter name.","Consider using a singular noun for the parameter name."