New-AzureRmDataFactoryGatewayAuthKey

NAME New-AzureRmDataFactoryGatewayAuthKey



SYNOPSIS

Creates auth key for an Azure Data Factory Gateway.





SYNTAX

New-AzureRmDataFactoryGatewayAuthKey [-ResourceGroupName] <String> [-DataFactoryName] <String> [-GatewayName] <String> [-KeyName] {key1 | key2}

[-DefaultProfile <IAzureContextContainer>] [-Confirm] [-WhatIf] [<CommonParameters>]



New-AzureRmDataFactoryGatewayAuthKey [-InputObject] <PSDataFactory> [-GatewayName] <String> [-KeyName] {key1 | key2} [-DefaultProfile

<IAzureContextContainer>] [-Confirm] [-WhatIf] [<CommonParameters>]





DESCRIPTION

The New-AzureRmDataFactoryGatewayAuthKey cmdlet creates gateway auth key for a specified Azure Data Factory gateway. You register the gateway with

a cloud service by using this 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



-KeyName <String>

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



Required? true

Position? 3

Default value None

Accept pipeline input? True (ByPropertyName)

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



-Confirm [<SwitchParameter>]

Prompts you for confirmation before running the cmdlet.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]

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



Required? false

Position? named

Default value False

Accept pipeline input? False

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: Creates a gateway auth key for Key1



PS C:\\> New-AzureRmDataFactoryGatewayAuthKey -ResourceGroup 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.







RELATED LINKS

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

New-AzureRmDataFactoryGateway

Get-AzureRmDataFactoryGatewayAuthKey