Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ The PowerShell command sequence for data flow debug workflow should be:

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

Add data flow package into debug session "550effe4-93a3-485c-8525-eaf25259efbd" of "WikiADF" data factory.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,11 @@ This command subscribes the event trigger to the specified external service even
## EXAMPLES

### Example 1
```powershell
Add-AzDataFactoryV2TriggerSubscription -ResourceGroupName ADF -DataFactoryName WikiADF -Name Trigger1
```
PS C:\> Add-AzDataFactoryV2TriggerSubscription -ResourceGroupName ADF -DataFactoryName WikiADF -Name Trigger1

```output
TriggerName Status
----------- ------
Trigger1 Provisioning
Expand Down
12 changes: 9 additions & 3 deletions src/DataFactory/DataFactoryV2/help/Get-AzDataFactory.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
---
---
external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactories.dll-Help.xml
Module Name: Az.DataFactory
ms.assetid: ECE1F469-E3C3-4294-A288-8BAE851E8599
Expand Down Expand Up @@ -26,8 +26,11 @@ If you do not specify a name, this cmdlet gets information about all of the data
## EXAMPLES

### Example 1: Get all data factories
```powershell
Get-AzDataFactory -ResourceGroupName "ADF"
```
PS C:\>Get-AzDataFactory -ResourceGroupName "ADF"

```output
DataFactoryName : WikiADF
ResourceGroupName : ADF
Location : WestUS
Expand All @@ -44,8 +47,11 @@ Properties : Microsoft.WindowsAzure.Commands.Utilities.PSDataFactoryConfi
This command displays information about all data factories in the Azure subscription.

### Example 2: Get a specific data factory
```powershell
$DataFactory = Get-AzDataFactory -ResourceGroupName "ADF" -Name "WikiADF"
```
PS C:\>$DataFactory = Get-AzDataFactory -ResourceGroupName "ADF" -Name "WikiADF"

```output
DataFactoryName : WikiADF
ResourceGroupName : ADF
Location : westus
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
---
---
external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactories.dll-Help.xml
Module Name: Az.DataFactory
ms.assetid: F8C67F7B-64C5-45E4-A0BF-32212BEBE885
Expand Down Expand Up @@ -37,8 +37,11 @@ The **Get-AzDataFactoryActivityWindow** cmdlet gets information about the activi
## EXAMPLES

### Example 1: Get activity windows associated with a data factory
```powershell
Get-AzDataFactoryActivityWindow -DataFactoryName "WikiADF" -ResourceGroupName "ADF" -Top 3
```
PS C:\>Get-AzDataFactoryActivityWindow -DataFactoryName "WikiADF" -ResourceGroupName "ADF" -Top 3

```output
ResourceGroupName : ADF
DataFactoryName : WikiADF
PipelineName : DP_WikipediaSamplePipeline
Expand Down
17 changes: 13 additions & 4 deletions src/DataFactory/DataFactoryV2/help/Get-AzDataFactoryDataset.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
---
---
external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactories.dll-Help.xml
Module Name: Az.DataFactory
ms.assetid: BB18EEF3-570A-4667-AF0E-FCEEE17B4905
Expand Down Expand Up @@ -33,8 +33,11 @@ If you do not specify a name, this cmdlet gets information about all the dataset
## EXAMPLES

### Example 1: Get information about all datasets
```powershell
Get-AzDataFactoryDataset -ResourceGroupName "ADF" -DataFactoryName "WikiADF"
```
PS C:\>Get-AzDataFactoryDataset -ResourceGroupName "ADF" -DataFactoryName "WikiADF"

```output
DatasetName : DACuratedWikiData
ResourceGroupName : ADF
DataFactoryName : WikiADF
Expand Down Expand Up @@ -63,8 +66,11 @@ Structure : {}
This command gets information about all datasets in the data factory named WikiADF.

### Example 2: Get information about a specific dataset
```powershell
Get-AzDataFactoryDataset -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -Name "DAWikipediaClickEvents"
```
PS C:\>Get-AzDataFactoryDataset -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -Name "DAWikipediaClickEvents"

```output
DatasetName : DAWikipediaClickEvents
ResourceGroupName : ADF
DataFactoryName : WikiADF
Expand All @@ -77,8 +83,11 @@ Structure : {}
This command gets information about the dataset named DAWikipediaClickEvents in the data factory named WikiADF.

### Example 3: Get the location for a specific dataset
```powershell
(Get-AzDataFactoryDataset -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -Name "DAWikipediaClickEvents").Location
```
PS C:\>(Get-AzDataFactoryDataset -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -Name "DAWikipediaClickEvents").Location

```output
BlobPath : wikidatagateway/wikisampledatain/
FilenamePrefix :
Format :
Expand Down
12 changes: 9 additions & 3 deletions src/DataFactory/DataFactoryV2/help/Get-AzDataFactoryGateway.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
---
---
external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactories.dll-Help.xml
Module Name: Az.DataFactory
ms.assetid: D85FF5ED-23EA-48C7-8E61-D931713E0064
Expand Down Expand Up @@ -34,8 +34,11 @@ If you want to add an on-premises Microsoft SQL Server as a linked service to a
## EXAMPLES

### Example 1: Get all logical gateways in a data factory
```powershell
Get-AzDataFactoryGateway -ResourceGroupName "ADF" -DataFactoryName "WikiADF"
```
PS C:\>Get-AzDataFactoryGateway -ResourceGroupName "ADF" -DataFactoryName "WikiADF"

```output
Name : gateway1
Description :
Version : 1.3.5338.1
Expand All @@ -59,8 +62,11 @@ ExpiryTime :
This command gets information about all logical gateways for the data factory named WikiADF in the resource group named ADF.

### Example 2: Get a specific logical gateway in a data factory
```powershell
Get-AzDataFactoryGateway -ResourceGroupName "ADF" -Name "Gateway01" -DataFactoryName "WikiADF"
```
PS C:\>Get-AzDataFactoryGateway -ResourceGroupName "ADF" -Name "Gateway01" -DataFactoryName "WikiADF"

```output
Name : Gateway01
Description :
Version : 1.3.5338.1
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
---
---
external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactories.dll-Help.xml
Module Name: Az.DataFactory
online version: https://docs.microsoft.com/powershell/module/az.datafactory/get-azdatafactorygatewayauthkey
Expand Down Expand Up @@ -31,8 +31,11 @@ You register the gateway with a cloud service by using this key1 or key2 of this
## EXAMPLES

### Example 1: Gets auth key of a gateway
```powershell
Get-AzDataFactoryGatewayAuthKey -ResourceGroup ADFResource -GatewayName 'MyGateway' -DataFactoryName MyADF
```
PS C:\> Get-AzDataFactoryGatewayAuthKey -ResourceGroup ADFResource -GatewayName 'MyGateway' -DataFactoryName MyADF

```output
Key1 : DMG@632e739e-1053-4070-9102-8591f067526e@41fcbc45-c594-4152-a8f1-fcbcd6452aea@wu@ZgBjjX6GfJcrzTQInEV9PoOqsDrqOmC
gGHqUg1THLqA=
Key2 : DMG@632e739e-1053-4070-9102-8591f067526e@41fcbc45-c594-4152-a8f1-fcbcd6452aea@wu@kFXxBdFCEBeL7LPB3hA3LqLd1uNFbyv
Expand Down
10 changes: 5 additions & 5 deletions src/DataFactory/DataFactoryV2/help/Get-AzDataFactoryHub.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
---
---
external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactories.dll-Help.xml
Module Name: Az.DataFactory
ms.assetid: B07FE1A2-732D-4CCF-A0DF-3CF6B91FB3F3
Expand Down Expand Up @@ -33,15 +33,15 @@ If you do not specify a name, this cmdlet gets information about all of the hubs
## EXAMPLES

### Example 1: Get all data hubs
```
PS C:\>Get-AzDataFactoryHub -ResourceGroupName "ADFResourceGroup" -DataFactoryName "ADFDataFactory"
```powershell
Get-AzDataFactoryHub -ResourceGroupName "ADFResourceGroup" -DataFactoryName "ADFDataFactory"
```

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

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

This command gets information about the hub named MyDataHub in the Azure resource group named ADFResourceGroup and the data factory named ADFDataFactory.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
---
---
external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactories.dll-Help.xml
Module Name: Az.DataFactory
ms.assetid: DFA41A2B-7C8A-42CB-B0B6-5E6FF853EFEE
Expand Down Expand Up @@ -33,17 +33,20 @@ If you do not specify a name, this cmdlet gets information about all the linked
## EXAMPLES

### Example 1: Get information about all linked services
```
PS C:\>Get-AzDataFactoryLinkedService -ResourceGroupName "ADF" -DataFactoryName "WikiADF" | Format-List
```powershell
Get-AzDataFactoryLinkedService -ResourceGroupName "ADF" -DataFactoryName "WikiADF" | Format-List
```

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

### Example 2: Get information about a specific linked service
```powershell
Get-AzDataFactoryLinkedService -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -Name "HDILinkedService"
```
PS C:\>Get-AzDataFactoryLinkedService -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -Name "HDILinkedService"

```output
LinkedServiceName ResourceGroupName DataFactoryName Properties
----------------- ----------------- --------------- ----------
HDILinkedService ADF WikiADF Microsoft.DataFactories.HDInsightBYOCAsset
Expand All @@ -52,9 +55,9 @@ HDILinkedService ADF WikiADF Microsoft
This command gets information about the linked service named HDILinkedService in the data factory named WikiADF.

### Example 3: Get information about a specific linked service by specifying the DataFactory parameter
```
PS C:\>$DataFactory = Get-AzDataFactory -ResourceGroupName "ADF" -Name "ContosoFactory"
PS C:\> Get-AzDataFactoryLinkedService -DataFactory $DataFactory | Format-Table -Property LinkedServiceName, DataFactoryName, ResourceGroupName
```powershell
$DataFactory = Get-AzDataFactory -ResourceGroupName "ADF" -Name "ContosoFactory"
Get-AzDataFactoryLinkedService -DataFactory $DataFactory | Format-Table -Property LinkedServiceName, DataFactoryName, ResourceGroupName
```

The first command uses the Get-AzDataFactory cmdlet to get the data factory named ContosoFactory, and then stores it in the $DataFactory variable.
Expand Down
31 changes: 23 additions & 8 deletions src/DataFactory/DataFactoryV2/help/Get-AzDataFactoryPipeline.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
---
---
external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactories.dll-Help.xml
Module Name: Az.DataFactory
ms.assetid: 5224BDF5-D492-4160-893E-4BB5F76C22F3
Expand Down Expand Up @@ -33,17 +33,20 @@ If you do not specify a name, this cmdlet gets information about all the pipelin
## EXAMPLES

### Example 1: Get information about all pipelines
```
PS C:\>Get-AzDataFactoryPipeline -ResourceGroupName "ADF" -DataFactoryName "WikiADF"
```powershell
Get-AzDataFactoryPipeline -ResourceGroupName "ADF" -DataFactoryName "WikiADF"
```

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

### Example 2: Get information about a specific pipeline
```powershell
Get-AzDataFactoryPipeline -ResourceGroupName "ADF" -Name "DPWikisample" -DataFactoryName "WikiADF" | Format-List
```
PS C:\>Get-AzDataFactoryPipeline -ResourceGroupName "ADF" -Name "DPWikisample" -DataFactoryName "WikiADF" | Format-List

```output
PipelineName : DPWikisample
ResourceGroupName : ADF
DataFactoryName : WikiADF
Expand All @@ -56,8 +59,11 @@ That cmdlet formats the results.
For more information, type `Get-Help Format-List`.

### Example 3: Get the properties for a specific pipeline
```powershell
(Get-AzDataFactoryPipeline -ResourceGroupName "ADF" -Name DPWikisample -DataFactoryName "WikiADF").Properties
```
PS C:\> (Get-AzDataFactoryPipeline -ResourceGroupName "ADF" -Name DPWikisample -DataFactoryName "WikiADF").Properties

```output
Activities : {WikiHiveActivity, BlobToSqlCopyActivity}
Description : DP Wikipedia Sample Pipelines
End : 6/6/2014 8:00:00 AM
Expand All @@ -69,8 +75,11 @@ Start : 6/5/2014 8:00:00 PM
This command gets information for the pipeline named DPWikisample in the data factory named WikiADF, and then uses standard dot notation to view the **Properties** property associated with that pipeline.

### Example 4: Get the activities for a specific pipeline
```powershell
(Get-AzDataFactoryPipeline -ResourceGroupName "ADF" -Name "DPWikisample" -DataFactoryName "WikiADF").Properties.Activities
```
PS C:\>(Get-AzDataFactoryPipeline -ResourceGroupName "ADF" -Name "DPWikisample" -DataFactoryName "WikiADF").Properties.Activities

```output
Transformation : Microsoft.DataFactories.HDInsightActivityProperties
Description :
Inputs : {DAWikipediaClickEvents}
Expand All @@ -91,8 +100,11 @@ Policy : Microsoft.DataFactories.ActivityPolicy
This command gets information for the pipeline named DPWikisample in the data factory named WikiADF, and then uses standard dot notation to view the **Activities** property associated with that pipeline.

### Example 5: Get the runtime information for a specific pipeline
```powershell
(Get-AzDataFactoryPipeline -ResourceGroupName "ADF" -Name "DPWikisample" -DataFactoryName "WikiADF").Properties.RuntimeInfo
```
PS C:\>(Get-AzDataFactoryPipeline -ResourceGroupName "ADF" -Name "DPWikisample" -DataFactoryName "WikiADF").Properties.RuntimeInfo

```output
DeploymentTime
--------------
6/5/2014 10:36:46 PM
Expand All @@ -101,8 +113,11 @@ DeploymentTime
This command gets information for the pipeline named DPWikisample in the data factory named WikiADF, and then uses standard dot notation to view the **RuntimeInfo** property associated with that pipeline.

### Example 6: Get information about inputs for the first activity
```powershell
(Get-AzDataFactoryPipeline -ResourceGroupName "ADF" -Name "DPWikisample" -DataFactoryName "WikiADF11").Properties.Activities[0].Inputs | Format-List
```
PS C:\>(Get-AzDataFactoryPipeline -ResourceGroupName "ADF" -Name "DPWikisample" -DataFactoryName "WikiADF11").Properties.Activities[0].Inputs | Format-List

```output
EndTime :
Length :
Name : DAWikipediaClickEvents
Expand Down
7 changes: 5 additions & 2 deletions src/DataFactory/DataFactoryV2/help/Get-AzDataFactoryRun.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
---
---
external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactories.dll-Help.xml
Module Name: Az.DataFactory
ms.assetid: 7100B5F0-A07B-4305-BF80-1F52647A03AB
Expand Down Expand Up @@ -46,8 +46,11 @@ LatencyStatus :
## EXAMPLES

### Example 1: Get a dataset
```powershell
Get-AzDataFactoryRun -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -DatasetName "DAWikiAggregatedData" -StartDateTime 2014-05-21T16:00:00Z
```
PS C:\>Get-AzDataFactoryRun -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -DatasetName "DAWikiAggregatedData" -StartDateTime 2014-05-21T16:00:00Z

```output
Id : a7c4913c-9623-49b3-ae1e-3e45e2b68819
ResourceGroupName : ADF
DataFactoryName : WikiADF
Expand Down
7 changes: 5 additions & 2 deletions src/DataFactory/DataFactoryV2/help/Get-AzDataFactorySlice.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
---
---
external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactories.dll-Help.xml
Module Name: Az.DataFactory
ms.assetid: C102232A-C9C8-4CEE-8535-7C7A70057B06
Expand Down Expand Up @@ -57,7 +57,10 @@ For each of the slices, you can see more information about the run that produces

### Example 1: Get data slices for a dataset
```powershell
PS C:\>Get-AzDataFactorySlice -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -DatasetName "DAWikiAggregatedData" -StartDateTime 2014-05-20T10:00:00Z
Get-AzDataFactorySlice -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -DatasetName "DAWikiAggregatedData" -StartDateTime 2014-05-20T10:00:00Z
```

```output
ResourceGroupName : ADF
DataFactoryName : WikiADF
DatasetName : DAWikiAggregatedData
Expand Down
8 changes: 6 additions & 2 deletions src/DataFactory/DataFactoryV2/help/Get-AzDataFactoryV2.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,11 @@ If you do not specify a name, this cmdlet gets information about all of the data
## EXAMPLES

### Example 1: Get all data factories
```powershell
Get-AzDataFactoryV2 -ResourceGroupName "ADF"
```
PS C:\> Get-AzDataFactoryV2 -ResourceGroupName "ADF"

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

### Example 2: Get a specific data factory
```powershell
$DataFactory = Get-AzDataFactoryV2 -ResourceGroupName "ADF" -Name "WikiADF"
```
PS C:\> $DataFactory = Get-AzDataFactoryV2 -ResourceGroupName "ADF" -Name "WikiADF"

```output
DataFactoryName : WikiADF
DataFactoryId : /subscriptions/3e8e61b5-9a7d-4952-bfae-545ab997b9ea/resourceGroups/adf/providers/Microsoft.DataF
actory/factories/wikiadf
Expand Down
Loading