< Back

Get-AzureRmDataFactoryGatewayAuthKey

Tue Jan 29, 2019 9:41 pm

NAME Get-AzureRmDataFactoryGatewayAuthKey



SYNOPSIS

Gets gateway auth key for an Azure Data Factory.





SYNTAX

Get-AzureRmDataFactoryGatewayAuthKey [-ResourceGroupName] <String> [-DataFactoryName] <String> [-GatewayName] <String> [-DefaultProfile

<IAzureContextContainer>] [<CommonParameters>]



Get-AzureRmDataFactoryGatewayAuthKey [-InputObject] <PSDataFactory> [-GatewayName] <String> [-DefaultProfile <IAzureContextContainer>]

[<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.





PARAMETERS

-DataFactoryName <String>

The data factory name.



Required? true

Position? 1

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-DefaultProfile <IAzureContextContainer>

The credentials, account, tenant, and subscription used for communication with azure



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-GatewayName <String>

The data factory gateway name.



Required? true

Position? 2

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-InputObject <PSDataFactory>

The data factory object



Required? true

Position? 0

Default value None

Accept pipeline input? True (ByValue)

Accept wildcard characters? false



-ResourceGroupName <String>

The resource group name.



Required? true

Position? 0

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).



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



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.







RELATED LINKS

Online Version: https://docs.microsoft.com/en-us/powers ... wayauthkey

New-AzureRmDataFactoryGateway

New-AzureRmDataFactoryGatewayAuthKey