Skip to content

Commit a2f7a0c

Browse files
committed
Regenerate Batch help text
1 parent 121e0a7 commit a2f7a0c

File tree

7 files changed

+222
-69
lines changed

7 files changed

+222
-69
lines changed

src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchNodeFile.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,13 @@ Gets the properties of Batch node files.
1414

1515
### ComputeNode_Id (Default)
1616
```
17-
Get-AzureBatchNodeFile [-PoolId] <String> [-ComputeNodeId] <String> [[-Name] <String>]
17+
Get-AzureBatchNodeFile [-PoolId] <String> [-ComputeNodeId] <String> [[-Path] <String>]
1818
-BatchContext <BatchAccountContext> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
1919
```
2020

2121
### Task_Id
2222
```
23-
Get-AzureBatchNodeFile -JobId <String> -TaskId <String> [[-Name] <String>] -BatchContext <BatchAccountContext>
23+
Get-AzureBatchNodeFile -JobId <String> -TaskId <String> [[-Path] <String>] -BatchContext <BatchAccountContext>
2424
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
2525
```
2626

@@ -59,7 +59,7 @@ If you specify a compute node, but not a filter, this cmdlet returns properties
5959

6060
### Example 1: Get the properties of a node file associated with a task
6161
```
62-
PS C:\>Get-AzureBatchNodeFile -JobId "Job-000001" -TaskId "Task26" -Name "Stdout.txt" -BatchContext $Context
62+
PS C:\>Get-AzureBatchNodeFile -JobId "Job-000001" -TaskId "Task26" -Path "Stdout.txt" -BatchContext $Context
6363
IsDirectory Name Properties Url
6464
6565
----------- ---- ---------- ---
@@ -103,7 +103,7 @@ Therefore, the cmdlet performs a recursive file search is performed, and returns
103103

104104
### Example 4: Get a single file from a compute node
105105
```
106-
PS C:\>Get-AzureBatchNodeFile -PoolId "Pool22" -ComputeNodeId "ComputeNode01" -Name "Startup\StdOut.txt" -BatchContext $Context
106+
PS C:\>Get-AzureBatchNodeFile -PoolId "Pool22" -ComputeNodeId "ComputeNode01" -Path "Startup\StdOut.txt" -BatchContext $Context
107107
IsDirectory Name Properties Url
108108
----------- ---- ---------- ---
109109
False startup\stdout.txt Microsoft.Azure.Commands.Batch.Models.PSFile... https://cmdletexample.westus.Batch.contoso...
@@ -248,14 +248,14 @@ Accept pipeline input: False
248248
Accept wildcard characters: False
249249
```
250250
251-
### -Name
252-
Specifies the name of the node file for which this cmdlet retrieves properties.
251+
### -Path
252+
Specifies the path of the node file for which this cmdlet retrieves properties.
253253
You cannot specify wildcard characters.
254254
255255
```yaml
256256
Type: String
257257
Parameter Sets: ComputeNode_Id, Task_Id
258-
Aliases:
258+
Aliases: Name
259259

260260
Required: False
261261
Position: 2

src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchNodeFileContent.md

Lines changed: 13 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -14,28 +14,28 @@ Gets a Batch node file.
1414

1515
### Task_Id_Path
1616
```
17-
Get-AzureBatchNodeFileContent -JobId <String> -TaskId <String> [-Name] <String> -DestinationPath <String>
17+
Get-AzureBatchNodeFileContent -JobId <String> -TaskId <String> [-Path] <String> -DestinationPath <String>
1818
[-ByteRangeStart <Int64>] [-ByteRangeEnd <Int64>] -BatchContext <BatchAccountContext>
1919
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
2020
```
2121

2222
### Task_Id_Stream
2323
```
24-
Get-AzureBatchNodeFileContent -JobId <String> -TaskId <String> [-Name] <String> -DestinationStream <Stream>
24+
Get-AzureBatchNodeFileContent -JobId <String> -TaskId <String> [-Path] <String> -DestinationStream <Stream>
2525
[-ByteRangeStart <Int64>] [-ByteRangeEnd <Int64>] -BatchContext <BatchAccountContext>
2626
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
2727
```
2828

2929
### ComputeNode_Id_Path
3030
```
31-
Get-AzureBatchNodeFileContent [-PoolId] <String> [-ComputeNodeId] <String> [-Name] <String>
31+
Get-AzureBatchNodeFileContent [-PoolId] <String> [-ComputeNodeId] <String> [-Path] <String>
3232
-DestinationPath <String> [-ByteRangeStart <Int64>] [-ByteRangeEnd <Int64>]
3333
-BatchContext <BatchAccountContext> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
3434
```
3535

3636
### ComputeNode_Id_Stream
3737
```
38-
Get-AzureBatchNodeFileContent [-PoolId] <String> [-ComputeNodeId] <String> [-Name] <String>
38+
Get-AzureBatchNodeFileContent [-PoolId] <String> [-ComputeNodeId] <String> [-Path] <String>
3939
-DestinationStream <Stream> [-ByteRangeStart <Int64>] [-ByteRangeEnd <Int64>]
4040
-BatchContext <BatchAccountContext> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
4141
```
@@ -61,7 +61,7 @@ The **Get-AzureBatchNodeFileContent** cmdlet gets an Azure Batch node file and s
6161

6262
### Example 1: Get a Batch node file associated with a task and save the file
6363
```
64-
PS C:\>Get-AzureBatchNodeFileContent -JobId "Job01" -TaskId "Task01" -Name "StdOut.txt" -DestinationPath "E:\PowerShell\StdOut.txt" -BatchContext $Context
64+
PS C:\>Get-AzureBatchNodeFileContent -JobId "Job01" -TaskId "Task01" -Path "StdOut.txt" -DestinationPath "E:\PowerShell\StdOut.txt" -BatchContext $Context
6565
```
6666

6767
This command gets the node file that is named StdOut.txt, and saves it to the E:\PowerShell\StdOut.txt file path on the local computer.
@@ -70,7 +70,7 @@ Use the Get-AzureRmBatchAccountKeys cmdlet to assign a context to the $Context v
7070

7171
### Example 2: Get a Batch node file and save it to a specified file path using the pipeline
7272
```
73-
PS C:\>Get-AzureBatchNodeFile -JobId "Job02" -TaskId "Task02" -Name "StdErr.txt" -BatchContext $Context | Get-AzureBatchNodeFileContent -DestinationPath "E:\PowerShell\StdOut.txt" -BatchContext $Context
73+
PS C:\>Get-AzureBatchNodeFile -JobId "Job02" -TaskId "Task02" -Path "StdErr.txt" -BatchContext $Context | Get-AzureBatchNodeFileContent -DestinationPath "E:\PowerShell\StdOut.txt" -BatchContext $Context
7474
```
7575

7676
This command gets the node file that is named StdErr.txt by using the Get-AzureBatchNodeFile cmdlet.
@@ -81,7 +81,7 @@ The StdOut.txt node file is associated with the task that has the ID Task02 for
8181
### Example 3: Get a Batch node file associated with a task and direct it to a stream
8282
```
8383
PS C:\>$Stream = New-Object -TypeName "System.IO.MemoryStream"
84-
PS C:\> Get-AzureBatchNodeFileContent -JobId "Job03" -TaskId "Task11" -Name "StdOut.txt" -DestinationStream $Stream -BatchContext $Context
84+
PS C:\> Get-AzureBatchNodeFileContent -JobId "Job03" -TaskId "Task11" -Path "StdOut.txt" -DestinationStream $Stream -BatchContext $Context
8585
```
8686

8787
The first command creates a stream by using the New-Object cmdlet, and then stores it in the $Stream variable.
@@ -91,15 +91,15 @@ The command directs file contents to the stream in $Stream.
9191

9292
### Example 4: Get a node file from a compute node and save it
9393
```
94-
PS C:\>Get-AzureBatchNodeFileContent -PoolId "Pool01" -ComputeNodeId "ComputeNode01" -Name "Startup\StdOut.txt" -DestinationPath "E:\PowerShell\StdOut.txt" -BatchContext $Context
94+
PS C:\>Get-AzureBatchNodeFileContent -PoolId "Pool01" -ComputeNodeId "ComputeNode01" -Path "Startup\StdOut.txt" -DestinationPath "E:\PowerShell\StdOut.txt" -BatchContext $Context
9595
```
9696

9797
This command gets the node file Startup\StdOut.txt from the compute node that has the ID ComputeNode01 in the pool that has the ID Pool01.
9898
The command saves the file to the E:\PowerShell\StdOut.txt file path on the local computer.
9999

100100
### Example 5: Get a node file from a compute node and save it by using the pipeline
101101
```
102-
PS C:\>Get-AzureBatchNodeFile -PoolId "Pool01" -ComputeNodeId "ComputeNode01" -Name "Startup\StdOut.txt" -BatchContext $Context | Get-AzureBatchNodeFileContent -DestinationPath "E:\PowerShell\StdOut.txt" -BatchContext $Context
102+
PS C:\>Get-AzureBatchNodeFile -PoolId "Pool01" -ComputeNodeId "ComputeNode01" -Path "Startup\StdOut.txt" -BatchContext $Context | Get-AzureBatchNodeFileContent -DestinationPath "E:\PowerShell\StdOut.txt" -BatchContext $Context
103103
```
104104

105105
This command gets the node file Startup\StdOut.txt by using Get-AzureBatchNodeFile from the compute node that has the ID ComputeNode01.
@@ -110,7 +110,7 @@ That cmdlet saves the file to the E:\PowerShell\StdOut.txt file path on the loca
110110
### Example 6: Get a node file from a compute node and direct it to a stream
111111
```
112112
PS C:\>$Stream = New-Object -TypeName "System.IO.MemoryStream"
113-
PS C:\> Get-AzureBatchNodeFileContent -PoolId "Pool01" -ComputeNodeId "ComputeNode01" -Name "startup\stdout.txt" -DestinationStream $Stream -BatchContext $Context
113+
PS C:\> Get-AzureBatchNodeFileContent -PoolId "Pool01" -ComputeNodeId "ComputeNode01" -Path "startup\stdout.txt" -DestinationStream $Stream -BatchContext $Context
114114
```
115115

116116
The first command creates a stream by using the New-Object cmdlet, and then stores it in the $Stream variable.
@@ -254,14 +254,11 @@ Accept pipeline input: True (ByPropertyName)
254254
Accept wildcard characters: False
255255
```
256256
257-
### -Name
258-
Specifies the name of the node file that this cmdlet retrieves.
259-
You cannot specify wildcard characters.
260-
261-
```yaml
257+
### -Path
258+
The path of the node file to download.```yaml
262259
Type: String
263260
Parameter Sets: Task_Id_Path, Task_Id_Stream, ComputeNode_Id_Path, ComputeNode_Id_Stream
264-
Aliases:
261+
Aliases: Name
265262

266263
Required: True
267264
Position: 2

src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureBatchPool.md

Lines changed: 47 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -15,27 +15,28 @@ Creates a pool in the Batch service.
1515
### CloudServiceAndTargetDedicated (Default)
1616
```
1717
New-AzureBatchPool [-Id] <String> -VirtualMachineSize <String> [-DisplayName <String>]
18-
[-ResizeTimeout <TimeSpan>] [-TargetDedicated <Int32>] [-MaxTasksPerComputeNode <Int32>]
19-
[-TaskSchedulingPolicy <PSTaskSchedulingPolicy>] [-Metadata <IDictionary>]
18+
[-ResizeTimeout <TimeSpan>] [-TargetDedicatedComputeNodes <Int32>] [-TargetLowPriorityComputeNodes <Int32>]
19+
[-MaxTasksPerComputeNode <Int32>] [-TaskSchedulingPolicy <PSTaskSchedulingPolicy>] [-Metadata <IDictionary>]
2020
[-InterComputeNodeCommunicationEnabled] [-StartTask <PSStartTask>]
2121
[-CertificateReferences <PSCertificateReference[]>]
2222
[-ApplicationPackageReferences <PSApplicationPackageReference[]>]
2323
[-CloudServiceConfiguration <PSCloudServiceConfiguration>] [-NetworkConfiguration <PSNetworkConfiguration>]
24-
-BatchContext <BatchAccountContext> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm]
25-
[<CommonParameters>]
24+
[-UserAccounts <PSUserAccount[]>] -BatchContext <BatchAccountContext>
25+
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
2626
```
2727

2828
### VirtualMachineAndTargetDedicated
2929
```
3030
New-AzureBatchPool [-Id] <String> -VirtualMachineSize <String> [-DisplayName <String>]
31-
[-ResizeTimeout <TimeSpan>] [-TargetDedicated <Int32>] [-MaxTasksPerComputeNode <Int32>]
32-
[-TaskSchedulingPolicy <PSTaskSchedulingPolicy>] [-Metadata <IDictionary>]
31+
[-ResizeTimeout <TimeSpan>] [-TargetDedicatedComputeNodes <Int32>] [-TargetLowPriorityComputeNodes <Int32>]
32+
[-MaxTasksPerComputeNode <Int32>] [-TaskSchedulingPolicy <PSTaskSchedulingPolicy>] [-Metadata <IDictionary>]
3333
[-InterComputeNodeCommunicationEnabled] [-StartTask <PSStartTask>]
3434
[-CertificateReferences <PSCertificateReference[]>]
3535
[-ApplicationPackageReferences <PSApplicationPackageReference[]>]
3636
[-VirtualMachineConfiguration <PSVirtualMachineConfiguration>]
37-
[-NetworkConfiguration <PSNetworkConfiguration>] -BatchContext <BatchAccountContext>
38-
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
37+
[-NetworkConfiguration <PSNetworkConfiguration>] [-UserAccounts <PSUserAccount[]>]
38+
-BatchContext <BatchAccountContext> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm]
39+
[<CommonParameters>]
3940
```
4041

4142
### CloudServiceAndAutoScale
@@ -47,8 +48,8 @@ New-AzureBatchPool [-Id] <String> -VirtualMachineSize <String> [-DisplayName <St
4748
[-CertificateReferences <PSCertificateReference[]>]
4849
[-ApplicationPackageReferences <PSApplicationPackageReference[]>]
4950
[-CloudServiceConfiguration <PSCloudServiceConfiguration>] [-NetworkConfiguration <PSNetworkConfiguration>]
50-
-BatchContext <BatchAccountContext> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm]
51-
[<CommonParameters>]
51+
[-UserAccounts <PSUserAccount[]>] -BatchContext <BatchAccountContext>
52+
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
5253
```
5354

5455
### VirtualMachineAndAutoScale
@@ -60,8 +61,9 @@ New-AzureBatchPool [-Id] <String> -VirtualMachineSize <String> [-DisplayName <St
6061
[-CertificateReferences <PSCertificateReference[]>]
6162
[-ApplicationPackageReferences <PSApplicationPackageReference[]>]
6263
[-VirtualMachineConfiguration <PSVirtualMachineConfiguration>]
63-
[-NetworkConfiguration <PSNetworkConfiguration>] -BatchContext <BatchAccountContext>
64-
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
64+
[-NetworkConfiguration <PSNetworkConfiguration>] [-UserAccounts <PSUserAccount[]>]
65+
-BatchContext <BatchAccountContext> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm]
66+
[<CommonParameters>]
6567
```
6668

6769
## DESCRIPTION
@@ -71,7 +73,7 @@ The **New-AzureBatchPool** cmdlet creates a pool in the Azure Batch service unde
7173

7274
### Example 1: Create a new pool using the TargetDedicated parameter set
7375
```
74-
PS C:\>New-AzureBatchPool -Id "MyPool" -VirtualMachineSize "Small" -OSFamily "4" -TargetOSVersion "*" -TargetDedicated 3 -BatchContext $Context
76+
PS C:\>New-AzureBatchPool -Id "MyPool" -VirtualMachineSize "Small" -OSFamily "4" -TargetOSVersion "*" -TargetDedicatedComputeNodes 3 -BatchContext $Context
7577
```
7678

7779
This command creates a new pool with ID MyPool using the TargetDedicated parameter set.
@@ -313,8 +315,23 @@ Accept pipeline input: False
313315
Accept wildcard characters: False
314316
```
315317
316-
### -TargetDedicated
317-
Specifies the target number of compute nodes to allocate to the pool.
318+
### -TargetDedicatedComputeNodes
319+
Specifies the target number of dedicated compute nodes to allocate to the pool.
320+
321+
```yaml
322+
Type: Int32
323+
Parameter Sets: CloudServiceAndTargetDedicated, VirtualMachineAndTargetDedicated
324+
Aliases: TargetDedicated
325+
326+
Required: False
327+
Position: Named
328+
Default value: None
329+
Accept pipeline input: False
330+
Accept wildcard characters: False
331+
```
332+
333+
### -TargetLowPriorityComputeNodes
334+
Specifies the target number of low-priority compute nodes to allocate to the pool.
318335
319336
```yaml
320337
Type: Int32
@@ -343,6 +360,21 @@ Accept pipeline input: False
343360
Accept wildcard characters: False
344361
```
345362
363+
### -UserAccounts
364+
The list of user accounts to be created on each node in the pool.
365+
366+
```yaml
367+
Type: PSUserAccount[]
368+
Parameter Sets: (All)
369+
Aliases:
370+
371+
Required: False
372+
Position: Named
373+
Default value: None
374+
Accept pipeline input: False
375+
Accept wildcard characters: False
376+
```
377+
346378
### -VirtualMachineConfiguration
347379
Specifies configuration settings for a pool on the virtual machines infrastructure.
348380

0 commit comments

Comments
 (0)