Edit

New-AzDataFactoryGatewayAuthKey

  • Reference
Module:
Az.DataFactory

Creates auth key for an Azure Data Factory Gateway.

Syntax

New-AzDataFactoryGatewayAuthKey
   [-DataFactoryName] <String>
   [-GatewayName] <String>
   [-KeyName] <String>
   [-ResourceGroupName] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzDataFactoryGatewayAuthKey
   [-InputObject] <PSDataFactory>
   [-GatewayName] <String>
   [-KeyName] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The New-AzDataFactoryGatewayAuthKey cmdlet creates gateway auth key for a specified Azure Data Factory gateway. You register the gateway with a cloud service by using this key.

Examples

Example 1: Creates a gateway auth key for Key1

New-AzDataFactoryGatewayAuthKey -ResourceGroupName ADFResource -GatewayName 'MyGateway' -DataFactoryName MyADF -KeyName key1

Key1 : DMG@632e739e-1053-4070-9102-8591f067526e@41fcbc45-c594-4152-a8f1-fcbcd6452aea@wu@BH0EV9hu/o2IYGQzfYYD203XhdS6Tty
       fkYwYFbG6wBU=
Key2 :

This command creates a gateway auth key of Key1 for the data factory gateway named MyGateway.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-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

-KeyName

The name of gateway auth key to be regenerated, either 'key1' or 'key2'.

Type:String
Accepted values:key1, key2
Position:3
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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

PSDataFactory

String

Outputs

PSDataFactoryGatewayAuthKey

Notes

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