Skip to content

Commit db8032a

Browse files
committed
ADF help updates after code review comments
1 parent 74dbe82 commit db8032a

20 files changed

+97
-50
lines changed

src/ResourceManager/DataFactories/Commands.DataFactoryV2/help/Get-AzureRmDataFactoryV2IntegrationRuntime.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Get-AzureRmDataFactoryV2IntegrationRuntime [-Status] [-ResourceId] <String>
2525

2626
### ByIntegrationRuntimeObject
2727
```
28-
Get-AzureRmDataFactoryV2IntegrationRuntime [-Status] [-IntegrationRuntime] <PSIntegrationRuntime>
28+
Get-AzureRmDataFactoryV2IntegrationRuntime [-Status] [-InputObject] <PSIntegrationRuntime>
2929
```
3030

3131
## DESCRIPTION
@@ -126,7 +126,7 @@ Accept pipeline input: True (ByPropertyName)
126126
Accept wildcard characters: False
127127
```
128128
129-
### -IntegrationRuntime
129+
### -InputObject
130130
The integration runtime object.
131131
132132
```yaml

src/ResourceManager/DataFactories/Commands.DataFactoryV2/help/Get-AzureRmDataFactoryV2IntegrationRuntimeKey.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Get-AzureRmDataFactoryV2IntegrationRuntimeKey [-ResourceId] <String>
2525

2626
### ByIntegrationRuntimeObject
2727
```
28-
Get-AzureRmDataFactoryV2IntegrationRuntimeKey [-IntegrationRuntime] <PSIntegrationRuntime>
28+
Get-AzureRmDataFactoryV2IntegrationRuntimeKey [-InputObject] <PSIntegrationRuntime>
2929
```
3030

3131
## DESCRIPTION
@@ -61,7 +61,7 @@ Accept pipeline input: True (ByPropertyName)
6161
Accept wildcard characters: False
6262
```
6363
64-
### -IntegrationRuntime
64+
### -InputObject
6565
The integration runtime object.
6666
6767
```yaml

src/ResourceManager/DataFactories/Commands.DataFactoryV2/help/Get-AzureRmDataFactoryV2IntegrationRuntimeMetric.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Get-AzureRmDataFactoryV2IntegrationRuntimeMetric [-ResourceId] <String>
2525

2626
### ByIntegrationRuntimeObject
2727
```
28-
Get-AzureRmDataFactoryV2IntegrationRuntimeMetric [-IntegrationRuntime] <PSIntegrationRuntime>
28+
Get-AzureRmDataFactoryV2IntegrationRuntimeMetric [-InputObject] <PSIntegrationRuntime>
2929
```
3030

3131
## DESCRIPTION
@@ -61,7 +61,7 @@ Accept pipeline input: True (ByPropertyName)
6161
Accept wildcard characters: False
6262
```
6363
64-
### -IntegrationRuntime
64+
### -InputObject
6565
The integration runtime object.
6666
6767
```yaml

src/ResourceManager/DataFactories/Commands.DataFactoryV2/help/Invoke-AzureRmDataFactoryV2Pipeline.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,18 +20,18 @@ Invoke-AzureRmDataFactoryV2Pipeline [-ResourceGroupName] <String> [-DataFactoryN
2020

2121
### ByPipelineObjectByParameterFile
2222
```
23-
Invoke-AzureRmDataFactoryV2Pipeline [-Pipeline] <PSPipeline> [[-ParameterFile] <String>] [-WhatIf] [-Confirm]
23+
Invoke-AzureRmDataFactoryV2Pipeline [-InputObject] <PSPipeline> [[-ParameterFile] <String>] [-WhatIf] [-Confirm]
2424
```
2525

2626
### ByPipelineObjectByParameterObject
2727
```
28-
Invoke-AzureRmDataFactoryV2Pipeline [-Pipeline] <PSPipeline> [[-Parameters] <Hashtable>] [-WhatIf] [-Confirm]
28+
Invoke-AzureRmDataFactoryV2Pipeline [-InputObject] <PSPipeline> [[-Parameter] <Hashtable>] [-WhatIf] [-Confirm]
2929
```
3030

3131
### ByFactoryNameByParameterObject
3232
```
3333
Invoke-AzureRmDataFactoryV2Pipeline [-ResourceGroupName] <String> [-DataFactoryName] <String>
34-
[-PipelineName] <String> [[-Parameters] <Hashtable>] [-WhatIf] [-Confirm]
34+
[-PipelineName] <String> [[-Parameter] <Hashtable>] [-WhatIf] [-Confirm]
3535
```
3636

3737
## DESCRIPTION
@@ -94,7 +94,7 @@ Accept pipeline input: True (ByPropertyName)
9494
Accept wildcard characters: False
9595
```
9696
97-
### -Parameters
97+
### -Parameter
9898
Parameters for pipeline run.
9999
100100
```yaml
@@ -109,7 +109,7 @@ Accept pipeline input: True (ByPropertyName)
109109
Accept wildcard characters: False
110110
```
111111
112-
### -Pipeline
112+
### -InputObject
113113
The data factory object.
114114
115115
```yaml

src/ResourceManager/DataFactories/Commands.DataFactoryV2/help/New-AzureRmDataFactoryV2IntegrationRuntimeKey.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ New-AzureRmDataFactoryV2IntegrationRuntimeKey -KeyName <String> [-Force] [-Resou
2727
### ByIntegrationRuntimeObject
2828
```
2929
New-AzureRmDataFactoryV2IntegrationRuntimeKey -KeyName <String> [-Force]
30-
[-IntegrationRuntime] <PSIntegrationRuntime> [-WhatIf] [-Confirm]
30+
[-InputObject] <PSIntegrationRuntime> [-WhatIf] [-Confirm]
3131
```
3232

3333
## DESCRIPTION
@@ -93,7 +93,7 @@ Accept pipeline input: False
9393
Accept wildcard characters: False
9494
```
9595
96-
### -IntegrationRuntime
96+
### -InputObject
9797
The integration runtime object.
9898
9999
```yaml

src/ResourceManager/DataFactories/Commands.DataFactoryV2/help/New-AzureRmDataFactoryV2LinkedServiceEncryptedCredential.md

Lines changed: 49 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,15 @@ Encrypt credential in linked service with specified integration runtime.
1515
### ByFactoryName (Default)
1616
```
1717
New-AzureRmDataFactoryV2LinkedServiceEncryptedCredential [-IntegrationRuntimeName] <String>
18-
[-DefinitionFile] <String> [-ResourceGroupName] <String> [-DataFactoryName] <String>
18+
[-DefinitionFile] <String> [-Force] [-ResourceGroupName] <String> [-DataFactoryName] <String>
19+
[-WhatIf] [-Confirm]
1920
```
2021

2122
### ByFactoryObject
2223
```
2324
New-AzureRmDataFactoryV2LinkedServiceEncryptedCredential [-IntegrationRuntimeName] <String>
24-
[-DefinitionFile] <String> [-DataFactory] <PSDataFactory>
25+
[-DefinitionFile] <String> [-Force] [-DataFactory] <PSDataFactory>
26+
[-WhatIf] [-Confirm]
2527
```
2628

2729
## DESCRIPTION
@@ -83,6 +85,21 @@ Accept pipeline input: False
8385
Accept wildcard characters: False
8486
```
8587
88+
### -Force
89+
Runs the cmdlet without prompting for confirmation.
90+
91+
```yaml
92+
Type: SwitchParameter
93+
Parameter Sets: (All)
94+
Aliases:
95+
96+
Required: False
97+
Position: Named
98+
Default value: None
99+
Accept pipeline input: False
100+
Accept wildcard characters: False
101+
```
102+
86103
### -IntegrationRuntimeName
87104
The integration runtime name.
88105
@@ -113,6 +130,36 @@ Accept pipeline input: True (ByPropertyName)
113130
Accept wildcard characters: False
114131
```
115132
133+
### -Confirm
134+
Prompts you for confirmation before running the cmdlet.
135+
136+
```yaml
137+
Type: SwitchParameter
138+
Parameter Sets: (All)
139+
Aliases: cf
140+
141+
Required: False
142+
Position: Named
143+
Default value: None
144+
Accept pipeline input: False
145+
Accept wildcard characters: False
146+
```
147+
148+
### -WhatIf
149+
Shows what happens if the cmdlet runs, but doesn't run the cmdlet.
150+
151+
```yaml
152+
Type: SwitchParameter
153+
Parameter Sets: (All)
154+
Aliases: wi
155+
156+
Required: False
157+
Position: Named
158+
Default value: None
159+
Accept pipeline input: False
160+
Accept wildcard characters: False
161+
```
162+
116163
## INPUTS
117164
118165
### System.String

src/ResourceManager/DataFactories/Commands.DataFactoryV2/help/Remove-AzureRmDataFactoryV2.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Remove-AzureRmDataFactoryV2 [-ResourceGroupName] <String> [-Name] <String> [-For
1919

2020
### ByFactoryObject
2121
```
22-
Remove-AzureRmDataFactoryV2 [-DataFactory] <PSDataFactory> [-Force] [-WhatIf] [-Confirm]
22+
Remove-AzureRmDataFactoryV2 [-InputObject] <PSDataFactory> [-Force] [-WhatIf] [-Confirm]
2323
```
2424

2525
### ByResourceId
@@ -61,8 +61,8 @@ Accept pipeline input: False
6161
Accept wildcard characters: False
6262
```
6363
64-
### -DataFactory
65-
Specifies the PSDataFactory object to remove.
64+
### -InputObject
65+
Specifies the DataFactory object to remove.
6666
6767
```yaml
6868
Type: PSDataFactory

src/ResourceManager/DataFactories/Commands.DataFactoryV2/help/Remove-AzureRmDataFactoryV2Dataset.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Remove-AzureRmDataFactoryV2Dataset [-Name] <String> [-ResourceGroupName] <String
2020

2121
### ByInputObject
2222
```
23-
Remove-AzureRmDataFactoryV2Dataset [-Dataset] <PSDataset> [-Force] [-WhatIf] [-Confirm]
23+
Remove-AzureRmDataFactoryV2Dataset [-InputObject] <PSDataset> [-Force] [-WhatIf] [-Confirm]
2424
```
2525

2626
### ByResourceId
@@ -78,8 +78,8 @@ Accept pipeline input: True (ByPropertyName)
7878
Accept wildcard characters: False
7979
```
8080
81-
### -Dataset
82-
Specifies a PSDataset object to remove.
81+
### -InputObject
82+
Specifies a Dataset object to remove.
8383
8484
```yaml
8585
Type: PSDataset

src/ResourceManager/DataFactories/Commands.DataFactoryV2/help/Remove-AzureRmDataFactoryV2IntegrationRuntime.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Remove-AzureRmDataFactoryV2IntegrationRuntime [-Force] [-ResourceId] <String> [-
2525

2626
### ByIntegrationRuntimeObject
2727
```
28-
Remove-AzureRmDataFactoryV2IntegrationRuntime [-Force] [-IntegrationRuntime] <PSIntegrationRuntime> [-WhatIf]
28+
Remove-AzureRmDataFactoryV2IntegrationRuntime [-Force] [-InputObject] <PSIntegrationRuntime> [-WhatIf]
2929
[-Confirm]
3030
```
3131

@@ -74,7 +74,7 @@ Accept pipeline input: False
7474
Accept wildcard characters: False
7575
```
7676
77-
### -IntegrationRuntime
77+
### -InputObject
7878
The integration runtime object.
7979
8080
```yaml

src/ResourceManager/DataFactories/Commands.DataFactoryV2/help/Remove-AzureRmDataFactoryV2IntegrationRuntimeNode.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Remove-AzureRmDataFactoryV2IntegrationRuntimeNode -NodeName <String> [-Force] [-
2828
### ByIntegrationRuntimeObject
2929
```
3030
Remove-AzureRmDataFactoryV2IntegrationRuntimeNode -NodeName <String> [-Force]
31-
[-IntegrationRuntime] <PSIntegrationRuntime> [-WhatIf] [-Confirm]
31+
[-InputObject] <PSIntegrationRuntime> [-WhatIf] [-Confirm]
3232
```
3333

3434
## DESCRIPTION
@@ -90,7 +90,7 @@ Accept pipeline input: False
9090
Accept wildcard characters: False
9191
```
9292
93-
### -IntegrationRuntime
93+
### -InputObject
9494
The integration runtime object.
9595
9696
```yaml

src/ResourceManager/DataFactories/Commands.DataFactoryV2/help/Remove-AzureRmDataFactoryV2LinkedService.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Remove-AzureRmDataFactoryV2LinkedService [-Name] <String> [-ResourceGroupName] <
2020

2121
### ByInputObject
2222
```
23-
Remove-AzureRmDataFactoryV2LinkedService [-LinkedService] <PSLinkedService> [-Force] [-WhatIf] [-Confirm]
23+
Remove-AzureRmDataFactoryV2LinkedService [-InputObject] <PSLinkedService> [-Force] [-WhatIf] [-Confirm]
2424
```
2525

2626
### ByResourceId
@@ -93,8 +93,8 @@ Accept pipeline input: False
9393
Accept wildcard characters: False
9494
```
9595
96-
### -LinkedService
97-
Specifies the PSLinkedService object to remove.
96+
### -InputObject
97+
Specifies the LinkedService object to remove.
9898
9999
```yaml
100100
Type: PSLinkedService

src/ResourceManager/DataFactories/Commands.DataFactoryV2/help/Remove-AzureRmDataFactoryV2Pipeline.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Remove-AzureRmDataFactoryV2Pipeline [-Name] <String> [-ResourceGroupName] <Strin
2020

2121
### ByInputObject
2222
```
23-
Remove-AzureRmDataFactoryV2Pipeline [-Pipeline] <PSPipeline> [-Force] [-WhatIf] [-Confirm]
23+
Remove-AzureRmDataFactoryV2Pipeline [-InputObject] <PSPipeline> [-Force] [-WhatIf] [-Confirm]
2424
```
2525

2626
### ByResourceId
@@ -108,8 +108,8 @@ Accept pipeline input: False
108108
Accept wildcard characters: False
109109
```
110110
111-
### -Pipeline
112-
Specifies a PSPipeline object.
111+
### -InputObject
112+
Specifies a Pipeline object.
113113
This cmdlet removes the pipeline that this parameter specifies.
114114
115115
```yaml

src/ResourceManager/DataFactories/Commands.DataFactoryV2/help/Remove-AzureRmDataFactoryV2Trigger.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Remove-AzureRmDataFactoryV2Trigger [-Name] <String> [-ResourceGroupName] <String
2020

2121
### ByInputObject
2222
```
23-
Remove-AzureRmDataFactoryV2Trigger [-Trigger] <PSTrigger> [-Force] [-WhatIf] [-Confirm]
23+
Remove-AzureRmDataFactoryV2Trigger [-InputObject] <PSTrigger> [-Force] [-WhatIf] [-Confirm]
2424
```
2525

2626
### ByResourceId
@@ -137,8 +137,8 @@ Accept pipeline input: True (ByPropertyName)
137137
Accept wildcard characters: False
138138
```
139139
140-
### -Trigger
141-
TriggerName
140+
### -InputObject
141+
The Trigger object to remove.
142142
143143
```yaml
144144
Type: PSTrigger

src/ResourceManager/DataFactories/Commands.DataFactoryV2/help/Set-AzureRmDataFactoryV2.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Creates a data factory.
1414

1515
```
1616
Set-AzureRmDataFactoryV2 [-ResourceGroupName] <String> [-Name] <String> [-Location] <String>
17-
[[-Tags] <Hashtable>] [-Force] [-WhatIf] [-Confirm]
17+
[[-Tag] <Hashtable>] [-Force] [-WhatIf] [-Confirm]
1818
```
1919

2020
## DESCRIPTION
@@ -122,7 +122,7 @@ Accept pipeline input: True (ByPropertyName)
122122
Accept wildcard characters: False
123123
```
124124
125-
### -Tags
125+
### -Tag
126126
The tags of the data factory.
127127
128128
```yaml

src/ResourceManager/DataFactories/Commands.DataFactoryV2/help/Set-AzureRmDataFactoryV2IntegrationRuntime.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Set-AzureRmDataFactoryV2IntegrationRuntime [-Type <String>] [-Description <Strin
3434
Set-AzureRmDataFactoryV2IntegrationRuntime [-Type <String>] [-Description <String>] [-Location <String>]
3535
[-NodeSize <String>] [-NodeCount <Int32>] [-CatalogServerEndpoint <String>]
3636
[-CatalogAdminCredential <PSCredential>] [-CatalogPricingTier <String>] [-VNetId <String>] [-Subnet <String>]
37-
[-MaxParallelExecutionsPerNode <Int32>] [-Force] [-IntegrationRuntime] <PSIntegrationRuntime> [-WhatIf]
37+
[-MaxParallelExecutionsPerNode <Int32>] [-Force] [-InputObject] <PSIntegrationRuntime> [-WhatIf]
3838
[-Confirm]
3939
```
4040

@@ -165,7 +165,7 @@ Accept pipeline input: False
165165
Accept wildcard characters: False
166166
```
167167
168-
### -IntegrationRuntime
168+
### -InputObject
169169
The integration runtime object.
170170
171171
```yaml

src/ResourceManager/DataFactories/Commands.DataFactoryV2/help/Start-AzureRmDataFactoryV2IntegrationRuntime.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Start-AzureRmDataFactoryV2IntegrationRuntime [-Force] [-ResourceId] <String> [-W
2525

2626
### ByIntegrationRuntimeObject
2727
```
28-
Start-AzureRmDataFactoryV2IntegrationRuntime [-Force] [-IntegrationRuntime] <PSIntegrationRuntime> [-WhatIf]
28+
Start-AzureRmDataFactoryV2IntegrationRuntime [-Force] [-InputObject] <PSIntegrationRuntime> [-WhatIf]
2929
[-Confirm]
3030
```
3131

@@ -109,7 +109,7 @@ Accept pipeline input: False
109109
Accept wildcard characters: False
110110
```
111111
112-
### -IntegrationRuntime
112+
### -InputObject
113113
The integration runtime object.
114114
115115
```yaml

src/ResourceManager/DataFactories/Commands.DataFactoryV2/help/Start-AzureRmDataFactoryV2Trigger.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Start-AzureRmDataFactoryV2Trigger [-Name] <String> [-ResourceGroupName] <String>
2121

2222
### ByInputObject
2323
```
24-
Start-AzureRmDataFactoryV2Trigger [-Trigger] <PSTrigger> [-Force] [-WhatIf] [-Confirm]
24+
Start-AzureRmDataFactoryV2Trigger [-InputObject] <PSTrigger> [-Force] [-WhatIf] [-Confirm]
2525
```
2626

2727
### ByResourceId
@@ -142,8 +142,8 @@ Accept pipeline input: True (ByPropertyName)
142142
Accept wildcard characters: False
143143
```
144144
145-
### -Trigger
146-
TriggerName
145+
### -InputObject
146+
Trigger object to start.
147147
148148
```yaml
149149
Type: PSTrigger

0 commit comments

Comments
 (0)