Skip to content

Commit 8c31997

Browse files
Split Az.DataFactory Examples (#17061)
1 parent 7b7ff23 commit 8c31997

File tree

82 files changed

+450
-224
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

82 files changed

+450
-224
lines changed

src/DataFactory/DataFactoryV2/help/Add-AzDataFactoryV2DataFlowDebugSessionPackage.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ The PowerShell command sequence for data flow debug workflow should be:
4444

4545
### Example 1
4646
```powershell
47-
PS C:\WINDOWS\system32> Add-AzDataFactoryV2DataFlowDebugSessionPackage -ResourceGroupName adf -DataFactoryName UncycloADF -PackageFile "D:\dataflowps\addpackage.json" -SessionId 550effe4-93a3-485c-8525-eaf25259efbd
47+
Add-AzDataFactoryV2DataFlowDebugSessionPackage -ResourceGroupName adf -DataFactoryName UncycloADF -PackageFile "D:\dataflowps\addpackage.json" -SessionId 550effe4-93a3-485c-8525-eaf25259efbd
4848
```
4949

5050
Add data flow package into debug session "550effe4-93a3-485c-8525-eaf25259efbd" of "UncycloADF" data factory.

src/DataFactory/DataFactoryV2/help/Add-AzDataFactoryV2TriggerSubscription.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,11 @@ This command subscribes the event trigger to the specified external service even
3737
## EXAMPLES
3838

3939
### Example 1
40+
```powershell
41+
Add-AzDataFactoryV2TriggerSubscription -ResourceGroupName ADF -DataFactoryName UncycloADF -Name Trigger1
4042
```
41-
PS C:\> Add-AzDataFactoryV2TriggerSubscription -ResourceGroupName ADF -DataFactoryName UncycloADF -Name Trigger1
4243

44+
```output
4345
TriggerName Status
4446
----------- ------
4547
Trigger1 Provisioning

src/DataFactory/DataFactoryV2/help/Get-AzDataFactory.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
---
1+
---
22
external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactories.dll-Help.xml
33
Module Name: Az.DataFactory
44
ms.assetid: ECE1F469-E3C3-4294-A288-8BAE851E8599
@@ -26,8 +26,11 @@ If you do not specify a name, this cmdlet gets information about all of the data
2626
## EXAMPLES
2727

2828
### Example 1: Get all data factories
29+
```powershell
30+
Get-AzDataFactory -ResourceGroupName "ADF"
2931
```
30-
PS C:\>Get-AzDataFactory -ResourceGroupName "ADF"
32+
33+
```output
3134
DataFactoryName : UncycloADF
3235
ResourceGroupName : ADF
3336
Location : WestUS
@@ -44,8 +47,11 @@ Properties : Microsoft.WindowsAzure.Commands.Utilities.PSDataFactoryConfi
4447
This command displays information about all data factories in the Azure subscription.
4548

4649
### Example 2: Get a specific data factory
50+
```powershell
51+
$DataFactory = Get-AzDataFactory -ResourceGroupName "ADF" -Name "UncycloADF"
4752
```
48-
PS C:\>$DataFactory = Get-AzDataFactory -ResourceGroupName "ADF" -Name "UncycloADF"
53+
54+
```output
4955
DataFactoryName : UncycloADF
5056
ResourceGroupName : ADF
5157
Location : westus

src/DataFactory/DataFactoryV2/help/Get-AzDataFactoryActivityWindow.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
---
1+
---
22
external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactories.dll-Help.xml
33
Module Name: Az.DataFactory
44
ms.assetid: F8C67F7B-64C5-45E4-A0BF-32212BEBE885
@@ -37,8 +37,11 @@ The **Get-AzDataFactoryActivityWindow** cmdlet gets information about the activi
3737
## EXAMPLES
3838

3939
### Example 1: Get activity windows associated with a data factory
40+
```powershell
41+
Get-AzDataFactoryActivityWindow -DataFactoryName "UncycloADF" -ResourceGroupName "ADF" -Top 3
4042
```
41-
PS C:\>Get-AzDataFactoryActivityWindow -DataFactoryName "UncycloADF" -ResourceGroupName "ADF" -Top 3
43+
44+
```output
4245
ResourceGroupName : ADF
4346
DataFactoryName : UncycloADF
4447
PipelineName : DP_UncyclopediaSamplePipeline

src/DataFactory/DataFactoryV2/help/Get-AzDataFactoryDataset.md

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
---
1+
---
22
external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactories.dll-Help.xml
33
Module Name: Az.DataFactory
44
ms.assetid: BB18EEF3-570A-4667-AF0E-FCEEE17B4905
@@ -33,8 +33,11 @@ If you do not specify a name, this cmdlet gets information about all the dataset
3333
## EXAMPLES
3434

3535
### Example 1: Get information about all datasets
36+
```powershell
37+
Get-AzDataFactoryDataset -ResourceGroupName "ADF" -DataFactoryName "UncycloADF"
3638
```
37-
PS C:\>Get-AzDataFactoryDataset -ResourceGroupName "ADF" -DataFactoryName "UncycloADF"
39+
40+
```output
3841
DatasetName : DACuratedUncycloData
3942
ResourceGroupName : ADF
4043
DataFactoryName : UncycloADF
@@ -63,8 +66,11 @@ Structure : {}
6366
This command gets information about all datasets in the data factory named UncycloADF.
6467

6568
### Example 2: Get information about a specific dataset
69+
```powershell
70+
Get-AzDataFactoryDataset -ResourceGroupName "ADF" -DataFactoryName "UncycloADF" -Name "DAUncyclopediaClickEvents"
6671
```
67-
PS C:\>Get-AzDataFactoryDataset -ResourceGroupName "ADF" -DataFactoryName "UncycloADF" -Name "DAUncyclopediaClickEvents"
72+
73+
```output
6874
DatasetName : DAUncyclopediaClickEvents
6975
ResourceGroupName : ADF
7076
DataFactoryName : UncycloADF
@@ -77,8 +83,11 @@ Structure : {}
7783
This command gets information about the dataset named DAUncyclopediaClickEvents in the data factory named UncycloADF.
7884

7985
### Example 3: Get the location for a specific dataset
86+
```powershell
87+
(Get-AzDataFactoryDataset -ResourceGroupName "ADF" -DataFactoryName "UncycloADF" -Name "DAUncyclopediaClickEvents").Location
8088
```
81-
PS C:\>(Get-AzDataFactoryDataset -ResourceGroupName "ADF" -DataFactoryName "UncycloADF" -Name "DAUncyclopediaClickEvents").Location
89+
90+
```output
8291
BlobPath : wikidatagateway/wikisampledatain/
8392
FilenamePrefix :
8493
Format :

src/DataFactory/DataFactoryV2/help/Get-AzDataFactoryGateway.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
---
1+
---
22
external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactories.dll-Help.xml
33
Module Name: Az.DataFactory
44
ms.assetid: D85FF5ED-23EA-48C7-8E61-D931713E0064
@@ -34,8 +34,11 @@ If you want to add an on-premises Microsoft SQL Server as a linked service to a
3434
## EXAMPLES
3535

3636
### Example 1: Get all logical gateways in a data factory
37+
```powershell
38+
Get-AzDataFactoryGateway -ResourceGroupName "ADF" -DataFactoryName "UncycloADF"
3739
```
38-
PS C:\>Get-AzDataFactoryGateway -ResourceGroupName "ADF" -DataFactoryName "UncycloADF"
40+
41+
```output
3942
Name : gateway1
4043
Description :
4144
Version : 1.3.5338.1
@@ -59,8 +62,11 @@ ExpiryTime :
5962
This command gets information about all logical gateways for the data factory named UncycloADF in the resource group named ADF.
6063

6164
### Example 2: Get a specific logical gateway in a data factory
65+
```powershell
66+
Get-AzDataFactoryGateway -ResourceGroupName "ADF" -Name "Gateway01" -DataFactoryName "UncycloADF"
6267
```
63-
PS C:\>Get-AzDataFactoryGateway -ResourceGroupName "ADF" -Name "Gateway01" -DataFactoryName "UncycloADF"
68+
69+
```output
6470
Name : Gateway01
6571
Description :
6672
Version : 1.3.5338.1

src/DataFactory/DataFactoryV2/help/Get-AzDataFactoryGatewayAuthKey.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
---
1+
---
22
external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactories.dll-Help.xml
33
Module Name: Az.DataFactory
44
online version: https://docs.microsoft.com/powershell/module/az.datafactory/get-azdatafactorygatewayauthkey
@@ -31,8 +31,11 @@ You register the gateway with a cloud service by using this key1 or key2 of this
3131
## EXAMPLES
3232

3333
### Example 1: Gets auth key of a gateway
34+
```powershell
35+
Get-AzDataFactoryGatewayAuthKey -ResourceGroup ADFResource -GatewayName 'MyGateway' -DataFactoryName MyADF
3436
```
35-
PS C:\> Get-AzDataFactoryGatewayAuthKey -ResourceGroup ADFResource -GatewayName 'MyGateway' -DataFactoryName MyADF
37+
38+
```output
3639
Key1 : DMG@632e739e-1053-4070-9102-8591f067526e@41fcbc45-c594-4152-a8f1-fcbcd6452aea@wu@ZgBjjX6GfJcrzTQInEV9PoOqsDrqOmC
3740
gGHqUg1THLqA=
3841
Key2 : DMG@632e739e-1053-4070-9102-8591f067526e@41fcbc45-c594-4152-a8f1-fcbcd6452aea@wu@kFXxBdFCEBeL7LPB3hA3LqLd1uNFbyv

src/DataFactory/DataFactoryV2/help/Get-AzDataFactoryHub.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
---
1+
---
22
external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactories.dll-Help.xml
33
Module Name: Az.DataFactory
44
ms.assetid: B07FE1A2-732D-4CCF-A0DF-3CF6B91FB3F3
@@ -33,15 +33,15 @@ If you do not specify a name, this cmdlet gets information about all of the hubs
3333
## EXAMPLES
3434

3535
### Example 1: Get all data hubs
36-
```
37-
PS C:\>Get-AzDataFactoryHub -ResourceGroupName "ADFResourceGroup" -DataFactoryName "ADFDataFactory"
36+
```powershell
37+
Get-AzDataFactoryHub -ResourceGroupName "ADFResourceGroup" -DataFactoryName "ADFDataFactory"
3838
```
3939

4040
This command gets all data hubs in the Azure resource group named ADFResourceGroup and the data factory named ADFDataFactory.
4141

4242
### Example 2: Get a specific data hub
43-
```
44-
PS C:\>Get-AzDataFactoryHub -ResourceGroupName "ADFResourceGroup" -DataFactoryName "ADFDataFactory" -Name "MyDataHub"
43+
```powershell
44+
Get-AzDataFactoryHub -ResourceGroupName "ADFResourceGroup" -DataFactoryName "ADFDataFactory" -Name "MyDataHub"
4545
```
4646

4747
This command gets information about the hub named MyDataHub in the Azure resource group named ADFResourceGroup and the data factory named ADFDataFactory.

src/DataFactory/DataFactoryV2/help/Get-AzDataFactoryLinkedService.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
---
1+
---
22
external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactories.dll-Help.xml
33
Module Name: Az.DataFactory
44
ms.assetid: DFA41A2B-7C8A-42CB-B0B6-5E6FF853EFEE
@@ -33,17 +33,20 @@ If you do not specify a name, this cmdlet gets information about all the linked
3333
## EXAMPLES
3434

3535
### Example 1: Get information about all linked services
36-
```
37-
PS C:\>Get-AzDataFactoryLinkedService -ResourceGroupName "ADF" -DataFactoryName "UncycloADF" | Format-List
36+
```powershell
37+
Get-AzDataFactoryLinkedService -ResourceGroupName "ADF" -DataFactoryName "UncycloADF" | Format-List
3838
```
3939

4040
This command gets information about all linked services in the data factory named UncycloADF, and then passes the linked services to the Format-List cmdlet by using the pipeline operator.
4141
That cmdlet formats the results.
4242
For more information, type `Get-Help Format-List`.
4343

4444
### Example 2: Get information about a specific linked service
45+
```powershell
46+
Get-AzDataFactoryLinkedService -ResourceGroupName "ADF" -DataFactoryName "UncycloADF" -Name "HDILinkedService"
4547
```
46-
PS C:\>Get-AzDataFactoryLinkedService -ResourceGroupName "ADF" -DataFactoryName "UncycloADF" -Name "HDILinkedService"
48+
49+
```output
4750
LinkedServiceName ResourceGroupName DataFactoryName Properties
4851
----------------- ----------------- --------------- ----------
4952
HDILinkedService ADF UncycloADF Microsoft.DataFactories.HDInsightBYOCAsset
@@ -52,9 +55,9 @@ HDILinkedService ADF UncycloADF Microsoft
5255
This command gets information about the linked service named HDILinkedService in the data factory named UncycloADF.
5356

5457
### Example 3: Get information about a specific linked service by specifying the DataFactory parameter
55-
```
56-
PS C:\>$DataFactory = Get-AzDataFactory -ResourceGroupName "ADF" -Name "ContosoFactory"
57-
PS C:\> Get-AzDataFactoryLinkedService -DataFactory $DataFactory | Format-Table -Property LinkedServiceName, DataFactoryName, ResourceGroupName
58+
```powershell
59+
$DataFactory = Get-AzDataFactory -ResourceGroupName "ADF" -Name "ContosoFactory"
60+
Get-AzDataFactoryLinkedService -DataFactory $DataFactory | Format-Table -Property LinkedServiceName, DataFactoryName, ResourceGroupName
5861
```
5962

6063
The first command uses the Get-AzDataFactory cmdlet to get the data factory named ContosoFactory, and then stores it in the $DataFactory variable.

src/DataFactory/DataFactoryV2/help/Get-AzDataFactoryPipeline.md

Lines changed: 23 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
---
1+
---
22
external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactories.dll-Help.xml
33
Module Name: Az.DataFactory
44
ms.assetid: 5224BDF5-D492-4160-893E-4BB5F76C22F3
@@ -33,17 +33,20 @@ If you do not specify a name, this cmdlet gets information about all the pipelin
3333
## EXAMPLES
3434

3535
### Example 1: Get information about all pipelines
36-
```
37-
PS C:\>Get-AzDataFactoryPipeline -ResourceGroupName "ADF" -DataFactoryName "UncycloADF"
36+
```powershell
37+
Get-AzDataFactoryPipeline -ResourceGroupName "ADF" -DataFactoryName "UncycloADF"
3838
```
3939

4040
This command gets information about all pipelines in the data factory named UncycloADF.
4141
You can either one of the following example commands.
4242
The second one uses a **DataFactory** object as a parameter.
4343

4444
### Example 2: Get information about a specific pipeline
45+
```powershell
46+
Get-AzDataFactoryPipeline -ResourceGroupName "ADF" -Name "DPUncyclosample" -DataFactoryName "UncycloADF" | Format-List
4547
```
46-
PS C:\>Get-AzDataFactoryPipeline -ResourceGroupName "ADF" -Name "DPUncyclosample" -DataFactoryName "UncycloADF" | Format-List
48+
49+
```output
4750
PipelineName : DPUncyclosample
4851
ResourceGroupName : ADF
4952
DataFactoryName : UncycloADF
@@ -56,8 +59,11 @@ That cmdlet formats the results.
5659
For more information, type `Get-Help Format-List`.
5760

5861
### Example 3: Get the properties for a specific pipeline
62+
```powershell
63+
(Get-AzDataFactoryPipeline -ResourceGroupName "ADF" -Name DPUncyclosample -DataFactoryName "UncycloADF").Properties
5964
```
60-
PS C:\> (Get-AzDataFactoryPipeline -ResourceGroupName "ADF" -Name DPUncyclosample -DataFactoryName "UncycloADF").Properties
65+
66+
```output
6167
Activities : {UncycloHiveActivity, BlobToSqlCopyActivity}
6268
Description : DP Uncyclopedia Sample Pipelines
6369
End : 6/6/2014 8:00:00 AM
@@ -69,8 +75,11 @@ Start : 6/5/2014 8:00:00 PM
6975
This command gets information for the pipeline named DPUncyclosample in the data factory named UncycloADF, and then uses standard dot notation to view the **Properties** property associated with that pipeline.
7076

7177
### Example 4: Get the activities for a specific pipeline
78+
```powershell
79+
(Get-AzDataFactoryPipeline -ResourceGroupName "ADF" -Name "DPUncyclosample" -DataFactoryName "UncycloADF").Properties.Activities
7280
```
73-
PS C:\>(Get-AzDataFactoryPipeline -ResourceGroupName "ADF" -Name "DPUncyclosample" -DataFactoryName "UncycloADF").Properties.Activities
81+
82+
```output
7483
Transformation : Microsoft.DataFactories.HDInsightActivityProperties
7584
Description :
7685
Inputs : {DAUncyclopediaClickEvents}
@@ -91,8 +100,11 @@ Policy : Microsoft.DataFactories.ActivityPolicy
91100
This command gets information for the pipeline named DPUncyclosample in the data factory named UncycloADF, and then uses standard dot notation to view the **Activities** property associated with that pipeline.
92101

93102
### Example 5: Get the runtime information for a specific pipeline
103+
```powershell
104+
(Get-AzDataFactoryPipeline -ResourceGroupName "ADF" -Name "DPUncyclosample" -DataFactoryName "UncycloADF").Properties.RuntimeInfo
94105
```
95-
PS C:\>(Get-AzDataFactoryPipeline -ResourceGroupName "ADF" -Name "DPUncyclosample" -DataFactoryName "UncycloADF").Properties.RuntimeInfo
106+
107+
```output
96108
DeploymentTime
97109
--------------
98110
6/5/2014 10:36:46 PM
@@ -101,8 +113,11 @@ DeploymentTime
101113
This command gets information for the pipeline named DPUncyclosample in the data factory named UncycloADF, and then uses standard dot notation to view the **RuntimeInfo** property associated with that pipeline.
102114

103115
### Example 6: Get information about inputs for the first activity
116+
```powershell
117+
(Get-AzDataFactoryPipeline -ResourceGroupName "ADF" -Name "DPUncyclosample" -DataFactoryName "UncycloADF11").Properties.Activities[0].Inputs | Format-List
104118
```
105-
PS C:\>(Get-AzDataFactoryPipeline -ResourceGroupName "ADF" -Name "DPUncyclosample" -DataFactoryName "UncycloADF11").Properties.Activities[0].Inputs | Format-List
119+
120+
```output
106121
EndTime :
107122
Length :
108123
Name : DAUncyclopediaClickEvents

src/DataFactory/DataFactoryV2/help/Get-AzDataFactoryRun.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
---
1+
---
22
external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactories.dll-Help.xml
33
Module Name: Az.DataFactory
44
ms.assetid: 7100B5F0-A07B-4305-BF80-1F52647A03AB
@@ -46,8 +46,11 @@ LatencyStatus :
4646
## EXAMPLES
4747

4848
### Example 1: Get a dataset
49+
```powershell
50+
Get-AzDataFactoryRun -ResourceGroupName "ADF" -DataFactoryName "UncycloADF" -DatasetName "DAUncycloAggregatedData" -StartDateTime 2014-05-21T16:00:00Z
4951
```
50-
PS C:\>Get-AzDataFactoryRun -ResourceGroupName "ADF" -DataFactoryName "UncycloADF" -DatasetName "DAUncycloAggregatedData" -StartDateTime 2014-05-21T16:00:00Z
52+
53+
```output
5154
Id : a7c4913c-9623-49b3-ae1e-3e45e2b68819
5255
ResourceGroupName : ADF
5356
DataFactoryName : UncycloADF

src/DataFactory/DataFactoryV2/help/Get-AzDataFactorySlice.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
---
1+
---
22
external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactories.dll-Help.xml
33
Module Name: Az.DataFactory
44
ms.assetid: C102232A-C9C8-4CEE-8535-7C7A70057B06
@@ -57,7 +57,10 @@ For each of the slices, you can see more information about the run that produces
5757

5858
### Example 1: Get data slices for a dataset
5959
```powershell
60-
PS C:\>Get-AzDataFactorySlice -ResourceGroupName "ADF" -DataFactoryName "UncycloADF" -DatasetName "DAUncycloAggregatedData" -StartDateTime 2014-05-20T10:00:00Z
60+
Get-AzDataFactorySlice -ResourceGroupName "ADF" -DataFactoryName "UncycloADF" -DatasetName "DAUncycloAggregatedData" -StartDateTime 2014-05-20T10:00:00Z
61+
```
62+
63+
```output
6164
ResourceGroupName : ADF
6265
DataFactoryName : UncycloADF
6366
DatasetName : DAUncycloAggregatedData

src/DataFactory/DataFactoryV2/help/Get-AzDataFactoryV2.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,11 @@ If you do not specify a name, this cmdlet gets information about all of the data
3131
## EXAMPLES
3232

3333
### Example 1: Get all data factories
34+
```powershell
35+
Get-AzDataFactoryV2 -ResourceGroupName "ADF"
3436
```
35-
PS C:\> Get-AzDataFactoryV2 -ResourceGroupName "ADF"
3637

38+
```output
3739
DataFactoryName : UncycloADF
3840
DataFactoryId : /subscriptions/3e8e61b5-9a7d-4952-bfae-545ab997b9ea/resourceGroups/adf/providers/Microsoft.DataFactory/factories/wikiadf
3941
ResourceGroupName : ADF
@@ -54,9 +56,11 @@ PS C:\> Get-AzDataFactoryV2 -ResourceGroupName "ADF"
5456
Displays information about all data factories in the Azure subscription.
5557

5658
### Example 2: Get a specific data factory
59+
```powershell
60+
$DataFactory = Get-AzDataFactoryV2 -ResourceGroupName "ADF" -Name "UncycloADF"
5761
```
58-
PS C:\> $DataFactory = Get-AzDataFactoryV2 -ResourceGroupName "ADF" -Name "UncycloADF"
5962

63+
```output
6064
DataFactoryName : UncycloADF
6165
DataFactoryId : /subscriptions/3e8e61b5-9a7d-4952-bfae-545ab997b9ea/resourceGroups/adf/providers/Microsoft.DataF
6266
actory/factories/wikiadf

0 commit comments

Comments
 (0)