Skip to content

Commit 2ea8fa2

Browse files
author
maddieclayton
authored
Merge pull request Azure#5107 from markcowl/asjobencoding
Update markdown help for AsJob parameter
2 parents 6920a75 + 79a865c commit 2ea8fa2

33 files changed

+607
-86
lines changed

src/ResourceManager/Compute/Commands.Compute/help/Add-AzureRMVhd.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Uploads a virtual hard disk from an on-premises virtual machine to a blob in a c
1414

1515
```
1616
Add-AzureRmVhd [[-ResourceGroupName] <String>] [-Destination] <Uri> [-LocalFilePath] <FileInfo>
17-
[[-NumberOfUploaderThreads] <Int32>] [[-BaseImageUriToPatch] <Uri>] [-OverWrite]
17+
[[-NumberOfUploaderThreads] <Int32>] [[-BaseImageUriToPatch] <Uri>] [-OverWrite] [-AsJob]
1818
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
1919
```
2020

@@ -59,6 +59,21 @@ This command adds a .vhd file to a storage account and specifies the SAS URI.
5959

6060
## PARAMETERS
6161

62+
### -AsJob
63+
Run cmdlet in the background and return a Job to track progress.
64+
65+
```yaml
66+
Type: SwitchParameter
67+
Parameter Sets: (All)
68+
Aliases:
69+
70+
Required: False
71+
Position: Named
72+
Default value: None
73+
Accept pipeline input: False
74+
Accept wildcard characters: False
75+
```
76+
6277
### -BaseImageUriToPatch
6378
Specifies the URI to a base image blob in Azure Blob Storage.
6479
An SAS can be specified as the value for this parameter.

src/ResourceManager/Compute/Commands.Compute/help/Invoke-AzureRmVMRunCommand.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,14 @@ Run command on the VM.
1313

1414
### DefaultParameter (Default)
1515
```
16-
Invoke-AzureRmVMRunCommand [-ResourceGroupName] <String> [-VMName] <String> -CommandId <String>
16+
Invoke-AzureRmVMRunCommand [-AsJob] [-ResourceGroupName] <String> [-VMName] <String> -CommandId <String>
1717
[-ScriptPath <String>] [-Parameter <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf]
1818
[-Confirm] [<CommonParameters>]
1919
```
2020

2121
### VMParameter
2222
```
23-
Invoke-AzureRmVMRunCommand -CommandId <String> [-ScriptPath <String>] [-Parameter <Hashtable>]
23+
Invoke-AzureRmVMRunCommand [-AsJob] -CommandId <String> [-ScriptPath <String>] [-Parameter <Hashtable>]
2424
[-VM] <PSVirtualMachine> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
2525
```
2626

@@ -38,6 +38,21 @@ Invoke a run command of RunPowerShellScript with overriding the script 'sample.p
3838

3939
## PARAMETERS
4040

41+
### -AsJob
42+
Run cmdlet in the background and return a Job to track progress.
43+
44+
```yaml
45+
Type: SwitchParameter
46+
Parameter Sets: (All)
47+
Aliases:
48+
49+
Required: False
50+
Position: Named
51+
Default value: None
52+
Accept pipeline input: False
53+
Accept wildcard characters: False
54+
```
55+
4156
### -CommandId
4257
The run command id.
4358

src/ResourceManager/Compute/Commands.Compute/help/New-AzureRmAvailabilitySet.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Creates an Azure availability set.
1515
```
1616
New-AzureRmAvailabilitySet [-ResourceGroupName] <String> [-Name] <String> [-Location] <String>
1717
[[-PlatformUpdateDomainCount] <Int32>] [[-PlatformFaultDomainCount] <Int32>] [[-Sku] <String>] [-Managed]
18-
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
18+
[-AsJob] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
1919
```
2020

2121
## DESCRIPTION
@@ -32,6 +32,21 @@ This command creates an availability set named AvailablitySet03 in the resource
3232

3333
## PARAMETERS
3434

35+
### -AsJob
36+
Run cmdlet in the background and return a Job to track progress.
37+
38+
```yaml
39+
Type: SwitchParameter
40+
Parameter Sets: (All)
41+
Aliases:
42+
43+
Required: False
44+
Position: Named
45+
Default value: None
46+
Accept pipeline input: False
47+
Accept wildcard characters: False
48+
```
49+
3550
### -DefaultProfile
3651
The credentials, account, tenant, and subscription used for communication with azure.
3752

src/ResourceManager/Compute/Commands.Compute/help/New-AzureRmContainerService.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Creates a container service.
1313
## SYNTAX
1414

1515
```
16-
New-AzureRmContainerService [-ResourceGroupName] <String> [-Name] <String>
16+
New-AzureRmContainerService [-AsJob] [-ResourceGroupName] <String> [-Name] <String>
1717
[-ContainerService] <PSContainerService> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm]
1818
[<CommonParameters>]
1919
```
@@ -42,6 +42,21 @@ The service is named csResourceGroup17.
4242

4343
## PARAMETERS
4444

45+
### -AsJob
46+
RRun cmdlet in the background and return a Job to track progress.
47+
48+
```yaml
49+
Type: SwitchParameter
50+
Parameter Sets: (All)
51+
Aliases:
52+
53+
Required: False
54+
Position: Named
55+
Default value: None
56+
Accept pipeline input: False
57+
Accept wildcard characters: False
58+
```
59+
4560
### -ContainerService
4661
Specifies a container service object that contains the properties for the new service.
4762
To obtain a **ContainerService** object, use the New-AzureRmContainerServiceConfig cmdlet.

src/ResourceManager/Compute/Commands.Compute/help/New-AzureRmDisk.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Creates a managed disk.
1212
## SYNTAX
1313

1414
```
15-
New-AzureRmDisk [-ResourceGroupName] <String> [-DiskName] <String> [-Disk] <PSDisk>
15+
New-AzureRmDisk [-AsJob] [-ResourceGroupName] <String> [-DiskName] <String> [-Disk] <PSDisk>
1616
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
1717
```
1818

@@ -39,6 +39,21 @@ The last command takes the disk object and creates a disk with name 'Disk01' in
3939

4040
## PARAMETERS
4141

42+
### -AsJob
43+
Run cmdlet in the background and return a Job to track progress.
44+
45+
```yaml
46+
Type: SwitchParameter
47+
Parameter Sets: (All)
48+
Aliases:
49+
50+
Required: False
51+
Position: Named
52+
Default value: None
53+
Accept pipeline input: False
54+
Accept wildcard characters: False
55+
```
56+
4257
### -DefaultProfile
4358
The credentials, account, tenant, and subscription used for communication with azure.
4459

src/ResourceManager/Compute/Commands.Compute/help/New-AzureRmSnapshot.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Creates a snapshot.
1212
## SYNTAX
1313

1414
```
15-
New-AzureRmSnapshot [-ResourceGroupName] <String> [-SnapshotName] <String> [-Snapshot] <PSSnapshot>
15+
New-AzureRmSnapshot [-AsJob] [-ResourceGroupName] <String> [-SnapshotName] <String> [-Snapshot] <PSSnapshot>
1616
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
1717
```
1818

@@ -39,6 +39,21 @@ The last command takes the snapshot object and creates a snapshot with name 'Sna
3939

4040
## PARAMETERS
4141

42+
### -AsJob
43+
Run cmdlet in the background and return a Job to track progress.
44+
45+
```yaml
46+
Type: SwitchParameter
47+
Parameter Sets: (All)
48+
Aliases:
49+
50+
Required: False
51+
Position: Named
52+
Default value: None
53+
Accept pipeline input: False
54+
Accept wildcard characters: False
55+
```
56+
4257
### -DefaultProfile
4358
The credentials, account, tenant, and subscription used for communication with azure.
4459

src/ResourceManager/Compute/Commands.Compute/help/New-AzureRmVM.md

Lines changed: 48 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
---
1+
---
22
external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml
33
ms.assetid: 05E6155D-4F0E-406B-9312-77AD97EF66EE
44
online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/new-azurermvm
@@ -15,17 +15,17 @@ Creates a virtual machine.
1515
### DefaultParameterSet (Default)
1616
```
1717
New-AzureRmVM [-ResourceGroupName] <String> [-Location] <String> [-VM] <PSVirtualMachine> [[-Zone] <String[]>]
18-
[-DisableBginfoExtension] [-Tags <Hashtable>] [-LicenseType <String>]
18+
[-DisableBginfoExtension] [-Tags <Hashtable>] [-LicenseType <String>] [-AsJob]
1919
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
2020
```
2121

22-
### StrategyParameterSet
22+
### SimpleParameterSet
2323
```
2424
New-AzureRmVM [[-ResourceGroupName] <String>] [[-Location] <String>] -Name <String> -Credential <PSCredential>
2525
[-VirtualNetworkName <String>] [-AddressPrefix <String>] [-SubnetName <String>]
2626
[-SubnetAddressPrefix <String>] [-PublicIpAddressName <String>] [-DomainNameLabel <String>]
2727
[-AllocationMethod <String>] [-SecurityGroupName <String>] [-OpenPorts <Int32[]>] [-ImageName <String>]
28-
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
28+
[-Size <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
2929
```
3030

3131
## DESCRIPTION
@@ -109,7 +109,7 @@ The address prefix for the virtual network which will be created for the VM.
109109

110110
```yaml
111111
Type: String
112-
Parameter Sets: StrategyParameterSet
112+
Parameter Sets: SimpleParameterSet
113113
Aliases:
114114

115115
Required: False
@@ -124,7 +124,7 @@ The IP allocation method for the public IP which will be created for the VM.
124124
125125
```yaml
126126
Type: String
127-
Parameter Sets: StrategyParameterSet
127+
Parameter Sets: SimpleParameterSet
128128
Aliases:
129129
Accepted values: Static, Dynamic
130130

@@ -135,12 +135,27 @@ Accept pipeline input: False
135135
Accept wildcard characters: False
136136
```
137137
138+
### -AsJob
139+
Run cmdlet in the background and return a Job to track progress.
140+
141+
```yaml
142+
Type: SwitchParameter
143+
Parameter Sets: (All)
144+
Aliases:
145+
146+
Required: False
147+
Position: Named
148+
Default value: None
149+
Accept pipeline input: False
150+
Accept wildcard characters: False
151+
```
152+
138153
### -Credential
139154
The administrator credentials for the VM.
140155
141156
```yaml
142157
Type: PSCredential
143-
Parameter Sets: StrategyParameterSet
158+
Parameter Sets: SimpleParameterSet
144159
Aliases:
145160

146161
Required: True
@@ -185,7 +200,7 @@ The subdomain label for the fully-qualified domain name (FQDN) of the VM. This
185200

186201
```yaml
187202
Type: String
188-
Parameter Sets: StrategyParameterSet
203+
Parameter Sets: SimpleParameterSet
189204
Aliases:
190205
191206
Required: False
@@ -200,7 +215,7 @@ The friendly image name upon which the VM will be built. These include: Win2016
200215

201216
```yaml
202217
Type: String
203-
Parameter Sets: StrategyParameterSet
218+
Parameter Sets: SimpleParameterSet
204219
Aliases:
205220
206221
Required: False
@@ -250,7 +265,7 @@ Accept wildcard characters: False
250265

251266
```yaml
252267
Type: String
253-
Parameter Sets: StrategyParameterSet
268+
Parameter Sets: SimpleParameterSet
254269
Aliases:
255270
256271
Required: False
@@ -265,7 +280,7 @@ The name of the VM resource.
265280

266281
```yaml
267282
Type: String
268-
Parameter Sets: StrategyParameterSet
283+
Parameter Sets: SimpleParameterSet
269284
Aliases:
270285
271286
Required: True
@@ -280,7 +295,7 @@ A list of ports to open on the network security group (NSG) for the created VM.
280295

281296
```yaml
282297
Type: Int32[]
283-
Parameter Sets: StrategyParameterSet
298+
Parameter Sets: SimpleParameterSet
284299
Aliases:
285300
286301
Required: False
@@ -295,7 +310,7 @@ The name of a new (or existing) public IP address for the created VM to use. If
295310

296311
```yaml
297312
Type: String
298-
Parameter Sets: StrategyParameterSet
313+
Parameter Sets: SimpleParameterSet
299314
Aliases:
300315
301316
Required: False
@@ -322,7 +337,7 @@ Accept wildcard characters: False
322337

323338
```yaml
324339
Type: String
325-
Parameter Sets: StrategyParameterSet
340+
Parameter Sets: SimpleParameterSet
326341
Aliases:
327342
328343
Required: False
@@ -337,7 +352,7 @@ The name of a new (or existing) network security group (NSG) for the created VM
337352

338353
```yaml
339354
Type: String
340-
Parameter Sets: StrategyParameterSet
355+
Parameter Sets: SimpleParameterSet
341356
Aliases:
342357
343358
Required: False
@@ -347,12 +362,27 @@ Accept pipeline input: False
347362
Accept wildcard characters: False
348363
```
349364

365+
### -Size
366+
The Virtual Machine Size. The Default Value is: Standard_DS1_v2.
367+
368+
```yaml
369+
Type: String
370+
Parameter Sets: SimpleParameterSet
371+
Aliases:
372+
373+
Required: False
374+
Position: Named
375+
Default value: Standard_DS1_v2
376+
Accept pipeline input: False
377+
Accept wildcard characters: False
378+
```
379+
350380
### -SubnetAddressPrefix
351381
The address prefix for the subnet which will be created for the VM.
352382

353383
```yaml
354384
Type: String
355-
Parameter Sets: StrategyParameterSet
385+
Parameter Sets: SimpleParameterSet
356386
Aliases:
357387
358388
Required: False
@@ -367,7 +397,7 @@ The name of a new (or existing) subnet for the created VM to use. If not specif
367397

368398
```yaml
369399
Type: String
370-
Parameter Sets: StrategyParameterSet
400+
Parameter Sets: SimpleParameterSet
371401
Aliases:
372402
373403
Required: False
@@ -399,7 +429,7 @@ The name of a new (or existing) virtual network for the created VM to use. If n
399429

400430
```yaml
401431
Type: String
402-
Parameter Sets: StrategyParameterSet
432+
Parameter Sets: SimpleParameterSet
403433
Aliases:
404434
405435
Required: False

0 commit comments

Comments
 (0)