Skip to content

Commit 241c795

Browse files
authored
Merge pull request Azure#4660 from hvermis/adfhelp
Adfhelp
2 parents eb60faa + 094cbc9 commit 241c795

33 files changed

+1171
-494
lines changed
Lines changed: 109 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
1+
---
2+
Module Name: AzureRM.DataFactoryV2
3+
Module Guid: e3c0f6bc-fe96-41a0-88f4-5e490a91f05d
4+
Download Help Link:
5+
Help Version:
6+
Locale: en-US
7+
---
8+
9+
# AzureRM.DataFactoryV2 Module
10+
## Description
11+
Azure Data Factory V2 is the data integration platform that goes beyond Azure Data Factory V1's orchestration and batch-processing of time-series log data, with a general purpose app model supporting modern data warehousing patterns and scenarios, lift-and-shift SSIS, and data-driven SaaS applications. Compose and manage reliable and secure data integration workflows at scale. Use native ADF data connectors and Integration Runtimes to move and transform cloud and on-premises data that can be unstructured, semi-structured, and structured with Hadoop, Azure Data Lake, Spark, SQL Server, Cosmos DB and many other data platforms.
12+
13+
## AzureRM.DataFactoryV2 Cmdlets
14+
### [Get-AzureRmDataFactoryV2](Get-AzureRmDataFactoryV2.md)
15+
Gets information about Data Factory.
16+
17+
### [Get-AzureRmDataFactoryV2ActivityRun](Get-AzureRmDataFactoryV2ActivityRun.md)
18+
Gets information about activity runs for a pipeline run.
19+
20+
### [Get-AzureRmDataFactoryV2Dataset](Get-AzureRmDataFactoryV2Dataset.md)
21+
Gets information about datasets in Data Factory.
22+
23+
### [Get-AzureRmDataFactoryV2IntegrationRuntime](Get-AzureRmDataFactoryV2IntegrationRuntime.md)
24+
Gets information about integration runtime resources.
25+
26+
### [Get-AzureRmDataFactoryV2IntegrationRuntimeKey](Get-AzureRmDataFactoryV2IntegrationRuntimeKey.md)
27+
Gets keys for a self-hosted integration runtime.
28+
29+
### [Get-AzureRmDataFactoryV2IntegrationRuntimeMetric](Get-AzureRmDataFactoryV2IntegrationRuntimeMetric.md)
30+
Gets metric data for an integration runtime.
31+
32+
### [Get-AzureRmDataFactoryV2LinkedService](Get-AzureRmDataFactoryV2LinkedService.md)
33+
Gets information about linked services in Data Factory.
34+
35+
### [Get-AzureRmDataFactoryV2Pipeline](Get-AzureRmDataFactoryV2Pipeline.md)
36+
Gets information about pipelines in Data Factory.
37+
38+
### [Get-AzureRmDataFactoryV2PipelineRun](Get-AzureRmDataFactoryV2PipelineRun.md)
39+
Gets information about pipeline runs.
40+
41+
### [Get-AzureRmDataFactoryV2Trigger](Get-AzureRmDataFactoryV2Trigger.md)
42+
Gets information about triggers in a data factory.
43+
44+
### [Get-AzureRmDataFactoryV2TriggerRun](Get-AzureRmDataFactoryV2TriggerRun.md)
45+
Returns information about trigger runs.
46+
47+
### [Invoke-AzureRmDataFactoryV2Pipeline](Invoke-AzureRmDataFactoryV2Pipeline.md)
48+
Invokes a pipeline to start a run for it.
49+
50+
### [New-AzureRmDataFactoryV2IntegrationRuntimeKey](New-AzureRmDataFactoryV2IntegrationRuntimeKey.md)
51+
Regenerate self-hosted integration runtime key.
52+
53+
### [New-AzureRmDataFactoryV2LinkedServiceEncryptedCredential](New-AzureRmDataFactoryV2LinkedServiceEncryptedCredential.md)
54+
Encrypt credential in linked service with specified integration runtime.
55+
56+
### [Remove-AzureRmDataFactoryV2](Remove-AzureRmDataFactoryV2.md)
57+
Removes a data factory.
58+
59+
### [Remove-AzureRmDataFactoryV2Dataset](Remove-AzureRmDataFactoryV2Dataset.md)
60+
Removes a dataset from Data Factory.
61+
62+
### [Remove-AzureRmDataFactoryV2IntegrationRuntime](Remove-AzureRmDataFactoryV2IntegrationRuntime.md)
63+
Removes an integration runtime.
64+
65+
### [Remove-AzureRmDataFactoryV2IntegrationRuntimeNode](Remove-AzureRmDataFactoryV2IntegrationRuntimeNode.md)
66+
Remove a node with the given name on an integration runtime.
67+
68+
### [Remove-AzureRmDataFactoryV2LinkedService](Remove-AzureRmDataFactoryV2LinkedService.md)
69+
Removes a linked service from Data Factory.
70+
71+
### [Remove-AzureRmDataFactoryV2Pipeline](Remove-AzureRmDataFactoryV2Pipeline.md)
72+
Removes a pipeline from Data Factory.
73+
74+
### [Remove-AzureRmDataFactoryV2Trigger](Remove-AzureRmDataFactoryV2Trigger.md)
75+
Removes a trigger from a data factory.
76+
77+
### [Set-AzureRmDataFactoryV2](Set-AzureRmDataFactoryV2.md)
78+
Creates a data factory.
79+
80+
### [Set-AzureRmDataFactoryV2Dataset](Set-AzureRmDataFactoryV2Dataset.md)
81+
Creates a dataset in Data Factory.
82+
83+
### [Set-AzureRmDataFactoryV2IntegrationRuntime](Set-AzureRmDataFactoryV2IntegrationRuntime.md)
84+
Updates an integration runtime.
85+
86+
### [Set-AzureRmDataFactoryV2LinkedService](Set-AzureRmDataFactoryV2LinkedService.md)
87+
Links a data store or a cloud service to Data Factory.
88+
89+
### [Set-AzureRmDataFactoryV2Pipeline](Set-AzureRmDataFactoryV2Pipeline.md)
90+
Creates a pipeline in Data Factory.
91+
92+
### [Set-AzureRmDataFactoryV2Trigger](Set-AzureRmDataFactoryV2Trigger.md)
93+
Creates a trigger in a data factory.
94+
95+
### [Start-AzureRmDataFactoryV2IntegrationRuntime](Start-AzureRmDataFactoryV2IntegrationRuntime.md)
96+
Starts a managed dedicated integration runtime.
97+
98+
### [Start-AzureRmDataFactoryV2Trigger](Start-AzureRmDataFactoryV2Trigger.md)
99+
Starts a trigger in a data factory.
100+
101+
### [Stop-AzureRmDataFactoryV2IntegrationRuntime](Stop-AzureRmDataFactoryV2IntegrationRuntime.md)
102+
Stops a managed dedicated integration runtime.
103+
104+
### [Stop-AzureRmDataFactoryV2Trigger](Stop-AzureRmDataFactoryV2Trigger.md)
105+
Stops a trigger in a data factory.
106+
107+
### [Sync-AzureRmDataFactoryV2IntegrationRuntimeCredential](Sync-AzureRmDataFactoryV2IntegrationRuntimeCredential.md)
108+
Synchronizes credentials among integration runtime nodes.
109+

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

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,14 @@ Gets information about Data Factory.
1414

1515
```
1616
Get-AzureRmDataFactoryV2 [-ResourceGroupName] <String> [[-Name] <String>]
17+
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
1718
```
1819

1920
## DESCRIPTION
2021
The Get-AzureRmDataFactoryV2 cmdlet gets information about data factories in an Azure resource group.
2122
If you specify the name of a data factory, this cmdlet gets information about that data factory.
2223
If you do not specify a name, this cmdlet gets information about all of the data factories in an Azure resource group.
2324

24-
2525
## EXAMPLES
2626

2727
### Example 1: Get all data factories
@@ -43,7 +43,6 @@ PS C:\> Get-AzureRmDataFactoryV2 -ResourceGroupName "ADF"
4343
Tags : {}
4444
Identity :
4545
ProvisioningState : Succeeded
46-
4746
```
4847

4948
Displays information about all data factories in the Azure subscription.
@@ -60,14 +59,28 @@ PS C:\> $DataFactory = Get-AzureRmDataFactoryV2 -ResourceGroupName "ADF" -Name "
6059
Tags : {}
6160
Identity : Microsoft.Azure.Management.DataFactory.Models.FactoryIdentity
6261
ProvisioningState : Succeeded
63-
6462
```
6563

6664
This command displays information about the data factory named UncycloADF in the subscription for the resource group named ADF, and then stores it in the $DataFactory variable.
6765
Specify the DataFactory parameter in subsequent cmdlets to use the data factory stored in $DataFactory.
6866

6967
## PARAMETERS
7068

69+
### -DefaultProfile
70+
The credentials, account, tenant, and subscription used for communication with azure.
71+
72+
```yaml
73+
Type: IAzureContextContainer
74+
Parameter Sets: (All)
75+
Aliases: AzureRmContext, AzureCredential
76+
77+
Required: False
78+
Position: Named
79+
Default value: None
80+
Accept pipeline input: False
81+
Accept wildcard characters: False
82+
```
83+
7184
### -Name
7285
Specifies the name of the data factory about which to get information.
7386
@@ -99,21 +112,23 @@ Accept pipeline input: True (ByPropertyName)
99112
Accept wildcard characters: False
100113
```
101114
115+
### CommonParameters
116+
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).
117+
102118
## INPUTS
103119
104120
### System.String
105121
106-
107122
## OUTPUTS
108123
109124
### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataFactory, Microsoft.Azure.Commands.DataFactoryV2, Version=0.1.9.0, Culture=neutral, PublicKeyToken=null]]
110125
Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataFactory
111126

112-
113127
## NOTES
114128
Keywords: azure, azurerm, arm, resource, management, manager, data, factories
115129

116130
## RELATED LINKS
131+
117132
[Set-AzureRmDataFactoryV2]()
118133

119134
[Remove-AzureRmDataFactoryV2]()

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

Lines changed: 24 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -15,20 +15,19 @@ Gets information about activity runs for a pipeline run.
1515
### ByFactoryName (Default)
1616
```
1717
Get-AzureRmDataFactoryV2ActivityRun [-PipelineRunId] <String> [-RunStartedAfter] <DateTime>
18-
[-RunStartedBefore] <DateTime> [[-ActivityName] <String>] [[-Status] <String>]
19-
[[-LinkedServiceName] <String>] [-ResourceGroupName] <String> [-DataFactoryName] <String>
18+
[-RunStartedBefore] <DateTime> [[-ActivityName] <String>] [[-Status] <String>] [[-LinkedServiceName] <String>]
19+
[-ResourceGroupName] <String> [-DataFactoryName] <String> [-DefaultProfile <IAzureContextContainer>]
20+
[<CommonParameters>]
2021
```
2122

2223
### ByFactoryObject
2324
```
2425
Get-AzureRmDataFactoryV2ActivityRun [-PipelineRunId] <String> [-RunStartedAfter] <DateTime>
25-
[-RunStartedBefore] <DateTime> [[-ActivityName] <String>] [[-Status] <String>]
26-
[[-LinkedServiceName] <String>] [-DataFactory] <PSDataFactory>
26+
[-RunStartedBefore] <DateTime> [[-ActivityName] <String>] [[-Status] <String>] [[-LinkedServiceName] <String>]
27+
[-DataFactory] <PSDataFactory> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
2728
```
2829

29-
3030
## DESCRIPTION
31-
3231
The **Get-AzureRmDataFactoryV2ActivityRun** cmdlet gets information about runs in Azure Data Factory for the specified pipeline run that happened in the given timeframe. Additionally, you can specify filters for activity name, linked service name that executed the run, and the status of the run.
3332

3433
## EXAMPLES
@@ -50,7 +49,6 @@ PS C:\> Get-AzureRmDataFactoryV2ActivityRun -ResourceGroupName "ADF" -DataFactor
5049
DurationInMs : 2768
5150
Status : Succeeded
5251
Error : {errorCode, message, failureType, target}
53-
5452
```
5553

5654
This command gets details about all activity runs in the pipeline run with ID "f288712d-fb08-4cb8-96ef-82d3b9b30621" that happened between "2017-09-01" and "2017-09-30".
@@ -102,6 +100,21 @@ Accept pipeline input: True (ByPropertyName)
102100
Accept wildcard characters: False
103101
```
104102
103+
### -DefaultProfile
104+
The credentials, account, tenant, and subscription used for communication with azure.
105+
106+
```yaml
107+
Type: IAzureContextContainer
108+
Parameter Sets: (All)
109+
Aliases: AzureRmContext, AzureCredential
110+
111+
Required: False
112+
Position: Named
113+
Default value: None
114+
Accept pipeline input: False
115+
Accept wildcard characters: False
116+
```
117+
105118
### -LinkedServiceName
106119
The linked service name.
107120
@@ -192,21 +205,23 @@ Accept pipeline input: False
192205
Accept wildcard characters: False
193206
```
194207
208+
### CommonParameters
209+
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).
210+
195211
## INPUTS
196212
197213
### Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataFactory
198214
System.String
199215
200-
201216
## OUTPUTS
202217
203218
### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.DataFactoryV2.Models.PSActivityRun, Microsoft.Azure.Commands.DataFactoryV2, Version=0.1.9.0, Culture=neutral, PublicKeyToken=null]]
204219
Microsoft.Azure.Commands.DataFactoryV2.Models.PSActivityRun
205220

206-
207221
## NOTES
208222

209223
## RELATED LINKS
224+
210225
[Invoke-AzureRmDataFactoryV2Pipeline]()
211226

212227
[Get-AzureRmDataFactoryV2PipelineRun]()

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

Lines changed: 21 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,13 @@ Gets information about datasets in Data Factory.
1515
### ByFactoryName (Default)
1616
```
1717
Get-AzureRmDataFactoryV2Dataset [[-Name] <String>] [-ResourceGroupName] <String> [-DataFactoryName] <String>
18+
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
1819
```
1920

2021
### ByFactoryObject
2122
```
2223
Get-AzureRmDataFactoryV2Dataset [[-Name] <String>] [-DataFactory] <PSDataFactory>
24+
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
2325
```
2426

2527
## DESCRIPTION
@@ -50,7 +52,6 @@ PS C:\> Get-AzureRmDataFactoryV2Dataset -ResourceGroupName "ADF" -DataFactoryNam
5052
DataFactoryName : UncycloADF
5153
Structure :
5254
Properties : Microsoft.Azure.Management.DataFactory.Models.AzureBlobDataset
53-
5455
```
5556

5657
This command gets information about all datasets in the data factory named UncycloADF.
@@ -64,7 +65,6 @@ PS C:\> Get-AzureRmDataFactoryV2Dataset -ResourceGroupName "ADF" -DataFactoryNam
6465
DataFactoryName : UncycloADF
6566
Structure :
6667
Properties : Microsoft.Azure.Management.DataFactory.Models.AzureBlobDataset
67-
6868
```
6969

7070
This command gets information about the dataset named DAUncyclopediaClickEvents in the data factory named UncycloADF.
@@ -104,6 +104,21 @@ Accept pipeline input: True (ByPropertyName)
104104
Accept wildcard characters: False
105105
```
106106
107+
### -DefaultProfile
108+
The credentials, account, tenant, and subscription used for communication with azure.
109+
110+
```yaml
111+
Type: IAzureContextContainer
112+
Parameter Sets: (All)
113+
Aliases: AzureRmContext, AzureCredential
114+
115+
Required: False
116+
Position: Named
117+
Default value: None
118+
Accept pipeline input: False
119+
Accept wildcard characters: False
120+
```
121+
107122
### -Name
108123
Specifies the name of the dataset about which to get information.
109124
@@ -135,22 +150,24 @@ Accept pipeline input: True (ByPropertyName)
135150
Accept wildcard characters: False
136151
```
137152
153+
### CommonParameters
154+
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).
155+
138156
## INPUTS
139157
140158
### System.String
141159
Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataFactory
142160
143-
144161
## OUTPUTS
145162
146163
### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataset, Microsoft.Azure.Commands.DataFactoryV2, Version=0.1.9.0, Culture=neutral, PublicKeyToken=null]]
147164
Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataset
148165

149-
150166
## NOTES
151167
Keywords: azure, azurerm, arm, resource, management, manager, data, factories
152168

153169
## RELATED LINKS
170+
154171
[Set-AzureRmDataFactoryV2Dataset]()
155172

156173
[Remove-AzureRmDataFactoryV2Dataset]()

0 commit comments

Comments
 (0)