Get-​Azure​Rm​Data​Factory​Gateway​Auth​Key

Gets gateway auth key for an Azure Data Factory.

Syntax

Get-AzureRmDataFactoryGatewayAuthKey
   [-DataFactory] <PSDataFactory>
   [-GatewayName] <String>
   [<CommonParameters>]
Get-AzureRmDataFactoryGatewayAuthKey
   [-ResourceGroupName] <String>
   [-DataFactoryName] <String>
   [-GatewayName] <String>
   [<CommonParameters>]

Description

The Get-AzureRmDataFactoryGatewayAuthKey cmdlet gets gateway auth key for a specified Azure Data Factory gateway. You register the gateway with a cloud service by using this key1 or key2 of this auth key.

Examples

Example 1: Gets auth key of a gateway

PS C:\> Get-AzureRmDataFactoryGatewayAuthKey -ResourceGroup ADFResource -GatewayName 'MyGateway' -DataFactoryName MyADF
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
       YmWxtV4WD3JQ=

This command gets gateway auth key for the data factory gateway named MyGateway.

Required Parameters

-DataFactory

The data factory object.

Type:PSDataFactory
Position:0
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-DataFactoryName

The data factory name.

Type:String
Position:1
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-GatewayName

The data factory gateway name.

Type:String
Position:2
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-ResourceGroupName

The resource group name.

Type:String
Position:0
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Inputs

Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory

System.String

Outputs

Microsoft.Azure.Commands.DataFactories.Models.PSDataFactoryGatewayAuthKey

Notes

  • Keywords: azure, azurerm, arm, resource, management, manager, data, factories