Skip to content

Commit

Permalink
Correct external help file for DataFactory (#25569)
Browse files Browse the repository at this point in the history
* correct external help file for DataFactory

* Update New-AzDataFactoryEncryptValue.md
  • Loading branch information
BethanyZhou authored Jul 18, 2024
1 parent 06d8952 commit 39e37db
Show file tree
Hide file tree
Showing 30 changed files with 35 additions and 35 deletions.
2 changes: 1 addition & 1 deletion src/DataFactory/DataFactory/help/Get-AzDataFactory.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactories.dll-Help.xml
external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactoryV1.dll-Help.xml
Module Name: Az.DataFactory
ms.assetid: ECE1F469-E3C3-4294-A288-8BAE851E8599
online version: https://learn.microsoft.com/powershell/module/az.datafactory/get-azdatafactory
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactories.dll-Help.xml
external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactoryV1.dll-Help.xml
Module Name: Az.DataFactory
ms.assetid: F8C67F7B-64C5-45E4-A0BF-32212BEBE885
online version: https://learn.microsoft.com/powershell/module/az.datafactory/get-azdatafactoryactivitywindow
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactories.dll-Help.xml
external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactoryV1.dll-Help.xml
Module Name: Az.DataFactory
ms.assetid: BB18EEF3-570A-4667-AF0E-FCEEE17B4905
online version: https://learn.microsoft.com/powershell/module/az.datafactory/get-azdatafactorydataset
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactories.dll-Help.xml
external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactoryV1.dll-Help.xml
Module Name: Az.DataFactory
ms.assetid: D85FF5ED-23EA-48C7-8E61-D931713E0064
online version: https://learn.microsoft.com/powershell/module/az.datafactory/get-azdatafactorygateway
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactories.dll-Help.xml
external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactoryV1.dll-Help.xml
Module Name: Az.DataFactory
online version: https://learn.microsoft.com/powershell/module/az.datafactory/get-azdatafactorygatewayauthkey
schema: 2.0.0
Expand Down
2 changes: 1 addition & 1 deletion src/DataFactory/DataFactory/help/Get-AzDataFactoryHub.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactories.dll-Help.xml
external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactoryV1.dll-Help.xml
Module Name: Az.DataFactory
ms.assetid: B07FE1A2-732D-4CCF-A0DF-3CF6B91FB3F3
online version: https://learn.microsoft.com/powershell/module/az.datafactory/get-azdatafactoryhub
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactories.dll-Help.xml
external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactoryV1.dll-Help.xml
Module Name: Az.DataFactory
ms.assetid: DFA41A2B-7C8A-42CB-B0B6-5E6FF853EFEE
online version: https://learn.microsoft.com/powershell/module/az.datafactory/get-azdatafactorylinkedservice
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactories.dll-Help.xml
external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactoryV1.dll-Help.xml
Module Name: Az.DataFactory
ms.assetid: 5224BDF5-D492-4160-893E-4BB5F76C22F3
online version: https://learn.microsoft.com/powershell/module/az.datafactory/get-azdatafactorypipeline
Expand Down
2 changes: 1 addition & 1 deletion src/DataFactory/DataFactory/help/Get-AzDataFactoryRun.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactories.dll-Help.xml
external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactoryV1.dll-Help.xml
Module Name: Az.DataFactory
ms.assetid: 7100B5F0-A07B-4305-BF80-1F52647A03AB
online version: https://learn.microsoft.com/powershell/module/az.datafactory/get-azdatafactoryrun
Expand Down
2 changes: 1 addition & 1 deletion src/DataFactory/DataFactory/help/Get-AzDataFactorySlice.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactories.dll-Help.xml
external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactoryV1.dll-Help.xml
Module Name: Az.DataFactory
ms.assetid: C102232A-C9C8-4CEE-8535-7C7A70057B06
online version: https://learn.microsoft.com/powershell/module/az.datafactory/get-azdatafactoryslice
Expand Down
2 changes: 1 addition & 1 deletion src/DataFactory/DataFactory/help/New-AzDataFactory.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactories.dll-Help.xml
external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactoryV1.dll-Help.xml
Module Name: Az.DataFactory
ms.assetid: 7B18FA1B-F616-4479-B2F0-620FC0E3E962
online version: https://learn.microsoft.com/powershell/module/az.datafactory/new-azdatafactory
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactories.dll-Help.xml
external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactoryV1.dll-Help.xml
Module Name: Az.DataFactory
ms.assetid: 352A4B94-E433-413B-91D1-6AA347563959
online version: https://learn.microsoft.com/powershell/module/az.datafactory/new-azdatafactorydataset
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactories.dll-Help.xml
external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactoryV1.dll-Help.xml
Module Name: Az.DataFactory
ms.assetid: 5BF24BC2-DEB6-4830-BDEA-841BAB070388
online version: https://learn.microsoft.com/powershell/module/az.datafactory/new-azdatafactoryencryptvalue
Expand Down Expand Up @@ -36,7 +36,7 @@ The **New-AzDataFactoryEncryptValue** cmdlet encrypts sensitive data, such as a

### Example 1: Encrypt a non-ODBC connection string
```powershell
$Value = ConvertTo-SecureString 'Data Source=ContosoServer;Initial Catalog=catalog;user id =user123;password=password123' -AsPlainText -Force
$Value = ConvertTo-SecureString 'Data Source=ContosoServer;Initial Catalog=catalog;user id =user123;password=******' -AsPlainText -Force
New-AzDataFactoryEncryptValue -GatewayName "WikiGateway" -DataFactoryName "WikiAdf" -Value $value -ResourceGroupName "ADF" -Type OnPremisesSqlLinkedService
```

Expand All @@ -59,7 +59,7 @@ The third command creates an encrypted value for the object stored in $Value and

### Example 3: Encrypt server name and credentials for File system linked service
```powershell
$Value = ConvertTo-SecureString '\\servername' -AsPlainText -Force
$Value = ConvertTo-SecureString "******" -AsPlainText -Force
$Credential = Get-Credential
New-AzDataFactoryEncryptValue -DataFactoryName "WikiADF" -GatewayName "WikiGateway" -ResourceGroupName "ADF" -Value $Value -Credential $Credential -Type OnPremisesFileSystemLinkedService
```
Expand All @@ -70,8 +70,8 @@ The third command creates an encrypted value for the object stored in $Value and

### Example 4: Encrypt credentials for HDFS linked service
```powershell
$UserName = ConvertTo-SecureString "domain\\username" -AsPlainText -Force
$Password = ConvertTo-SecureString "password" -AsPlainText -Force
$UserName = ConvertTo-SecureString "******" -AsPlainText -Force
$Password = ConvertTo-SecureString "******" -AsPlainText -Force
$Credential = New-Object System.Management.Automation.PSCredential ($UserName, $Password)
New-AzDataFactoryEncryptValue -DataFactoryName "MyDataFactory" -ResourceGroupName "MyResourceGroup" -GatewayName "MyDataManagementGateway" -Type HdfsLinkedService -AuthenticationType Windows -Credential $Credential -NonCredentialValue "http://server01.com:50070/webhdfs/v1/user/username"
```
Expand All @@ -83,7 +83,7 @@ The **New-AzDataFactoryEncryptValue** command creates an encrypted value for the

### Example 5: Encrypt credentials for ODBC linked service
```powershell
$Content = ConvertTo-SecureString "UID=username@contoso;PWD=password;" -AsPlainText -Force
$Content = ConvertTo-SecureString "UID=username@contoso;PWD=******;" -AsPlainText -Force
New-AzDataFactoryEncryptValue -ResourceGroupName $RGName -DataFactoryName $DFName -GatewayName $Gateway -Type OnPremisesOdbcLinkedService -AuthenticationType Basic -NonCredentialValue "Driver={SQL Server};Server=server01.database.contoso.net; Database=HDISScenarioTest;" -Value $content
```

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactories.dll-Help.xml
external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactoryV1.dll-Help.xml
Module Name: Az.DataFactory
ms.assetid: 4DCF54BA-CFFA-4555-8CA3-66B98F704EFB
online version: https://learn.microsoft.com/powershell/module/az.datafactory/new-azdatafactorygateway
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactories.dll-Help.xml
external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactoryV1.dll-Help.xml
Module Name: Az.DataFactory
online version: https://learn.microsoft.com/powershell/module/az.datafactory/new-azdatafactorygatewayauthkey
schema: 2.0.0
Expand Down
2 changes: 1 addition & 1 deletion src/DataFactory/DataFactory/help/New-AzDataFactoryHub.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactories.dll-Help.xml
external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactoryV1.dll-Help.xml
Module Name: Az.DataFactory
ms.assetid: B656B4C4-97DE-4F9F-937C-E115CB3F0E80
online version: https://learn.microsoft.com/powershell/module/az.datafactory/new-azdatafactoryhub
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactories.dll-Help.xml
external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactoryV1.dll-Help.xml
Module Name: Az.DataFactory
ms.assetid: 8CD2BE3E-2FA1-4EAB-BC01-B1E1E3203FF1
online version: https://learn.microsoft.com/powershell/module/az.datafactory/new-azdatafactorylinkedservice
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactories.dll-Help.xml
external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactoryV1.dll-Help.xml
Module Name: Az.DataFactory
ms.assetid: 30C1AF6C-A8DC-4CA0-9E5F-10641A29D0E8
online version: https://learn.microsoft.com/powershell/module/az.datafactory/new-azdatafactorypipeline
Expand Down
2 changes: 1 addition & 1 deletion src/DataFactory/DataFactory/help/Remove-AzDataFactory.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactories.dll-Help.xml
external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactoryV1.dll-Help.xml
Module Name: Az.DataFactory
ms.assetid: 3D2E9FAE-FE34-457A-BE95-BC61D025B07A
online version: https://learn.microsoft.com/powershell/module/az.datafactory/remove-azdatafactory
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactories.dll-Help.xml
external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactoryV1.dll-Help.xml
Module Name: Az.DataFactory
ms.assetid: 428BC568-A305-49AD-B6B8-B1BB5E9B822B
online version: https://learn.microsoft.com/powershell/module/az.datafactory/remove-azdatafactorydataset
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactories.dll-Help.xml
external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactoryV1.dll-Help.xml
Module Name: Az.DataFactory
ms.assetid: E1461540-DEAE-43C3-83DF-7DF3FE8D4EC0
online version: https://learn.microsoft.com/powershell/module/az.datafactory/remove-azdatafactorygateway
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactories.dll-Help.xml
external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactoryV1.dll-Help.xml
Module Name: Az.DataFactory
ms.assetid: 4C839730-B494-45BD-B5A1-F93B02AB4B2A
online version: https://learn.microsoft.com/powershell/module/az.datafactory/remove-azdatafactoryhub
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactories.dll-Help.xml
external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactoryV1.dll-Help.xml
Module Name: Az.DataFactory
ms.assetid: 9425D38D-5978-421F-A438-4463068C4628
online version: https://learn.microsoft.com/powershell/module/az.datafactory/remove-azdatafactorylinkedservice
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactories.dll-Help.xml
external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactoryV1.dll-Help.xml
Module Name: Az.DataFactory
ms.assetid: E1E0919A-062B-4794-ADE7-E17133A40604
online version: https://learn.microsoft.com/powershell/module/az.datafactory/remove-azdatafactorypipeline
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactories.dll-Help.xml
external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactoryV1.dll-Help.xml
Module Name: Az.DataFactory
ms.assetid: F522841A-4246-4028-A754-393D8DADD924
online version: https://learn.microsoft.com/powershell/module/az.datafactory/resume-azdatafactorypipeline
Expand Down
2 changes: 1 addition & 1 deletion src/DataFactory/DataFactory/help/Save-AzDataFactoryLog.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactories.dll-Help.xml
external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactoryV1.dll-Help.xml
Module Name: Az.DataFactory
ms.assetid: 5490BB24-127E-4C21-B85F-B70D817B659A
online version: https://learn.microsoft.com/powershell/module/az.datafactory/save-azdatafactorylog
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactories.dll-Help.xml
external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactoryV1.dll-Help.xml
Module Name: Az.DataFactory
ms.assetid: 663D27A3-0B51-48F5-81D0-8DDBC5A3A33C
online version: https://learn.microsoft.com/powershell/module/az.datafactory/set-azdatafactorygateway
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactories.dll-Help.xml
external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactoryV1.dll-Help.xml
Module Name: Az.DataFactory
ms.assetid: D853A91F-95E7-4C36-AC0F-2C10DFCF68F8
online version: https://learn.microsoft.com/powershell/module/az.datafactory/set-azdatafactorypipelineactiveperiod
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactories.dll-Help.xml
external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactoryV1.dll-Help.xml
Module Name: Az.DataFactory
ms.assetid: 1D07222C-17D1-421C-8C9B-37043CBCF517
online version: https://learn.microsoft.com/powershell/module/az.datafactory/set-azdatafactoryslicestatus
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactories.dll-Help.xml
external help file: Microsoft.Azure.PowerShell.Cmdlets.DataFactoryV1.dll-Help.xml
Module Name: Az.DataFactory
ms.assetid: 1FF0B0F9-4B2C-46BC-8BED-12BE865E4480
online version: https://learn.microsoft.com/powershell/module/az.datafactory/suspend-azdatafactorypipeline
Expand Down

0 comments on commit 39e37db

Please sign in to comment.