Edit

Share via

Get-AzDataFactoryGatewayAuthKey

  • Reference
Module:
Az.DataFactory

Gets gateway auth key for an Azure Data Factory.

Syntax

Get-AzDataFactoryGatewayAuthKey
   [-DataFactoryName] <String>
   [-GatewayName] <String>
   [-ResourceGroupName] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzDataFactoryGatewayAuthKey
   [-InputObject] <PSDataFactory>
   [-GatewayName] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The Get-AzDataFactoryGatewayAuthKey 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

Get-AzDataFactoryGatewayAuthKey -ResourceGroupName 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.

Parameters

-DataFactoryName

The data factory name.

Type:String
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-DefaultProfile

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

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-GatewayName

The data factory gateway name.

Type:String
Position:2
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-InputObject

The data factory object

Type:PSDataFactory
Aliases:DataFactory
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ResourceGroupName

The resource group name.

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

Inputs

PSDataFactory

String

Outputs

PSDataFactoryGatewayAuthKey

Notes

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