< Back

New-AzureRmDataFactoryGatewayKey

Tue Jan 29, 2019 9:41 pm

NAME New-AzureRmDataFactoryGatewayKey



SYNOPSIS

Creates a gateway key for an Azure Data Factory. This cmdlet is deprecated, and you should use New-AzureRmDataFactoryGatewayAuthKey instead.





SYNTAX

New-AzureRmDataFactoryGatewayKey [-DataFactory] <PSDataFactory> [-GatewayName] <String> [-DefaultProfile <IAzureContextContainer>]

[<CommonParameters>]



New-AzureRmDataFactoryGatewayKey [-ResourceGroupName] <String> [-DataFactoryName] <String> [-GatewayName] <String> [-DefaultProfile

<IAzureContextContainer>] [<CommonParameters>]





DESCRIPTION

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

cloud service by using this key. This cmdlet is deprecated, and you should use New-AzureRmDataFactoryGatewayAuthKey instead.





PARAMETERS

-DataFactory <PSDataFactory>

Specifies a PSDataFactory object. This cmdlet creates a gateway key for the data factory that this parameter specifies.



Required? true

Position? 0

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-DataFactoryName <String>

Specifies the name of a data factory. This cmdlet creates a gateway key for the data factory that this parameter specifies.



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>

Specifies the name of the gateway. This cmdlet creates a key for the gateway that this parameter specifies.



Required? true

Position? 2

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-ResourceGroupName <String>

Specifies the name of an Azure resource group. This cmdlet creates a key for a gateway that belongs to the group that this parameter specifies.



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

None

This cmdlet does not accept any input.





OUTPUTS

Microsoft.WindowsAzure.Commands.Utilities.PSDataFactoryGatewayKey







NOTES





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



Example 1: Create a gateway key



PS C:\\>New-AzureRmDataFactoryGatewayKey -ResourceGroupName "ADF" -GatewayName "ContosoGateway" -DataFactoryName "WikiADF" | Format-List

GatewayKey : ADF#40cbb3d9-2736-4794-a8a6-e6b839b4894f@a2d875ce-c9d7-4b8b-ad65-dd3ebbb9a940@8c0d1801-e863-44af-82e6-fb2f0c00f2ae@xz#Y9R0NhAeH3u7wgnr

JyiWj4Y/QIhH4fFilIdzZgwsVQA=



This command creates a gateway key for the data factory gateway named ContosoGateway, and then passes the gateway key to the Format-List cmdlet by

using the pipeline operator. For more information, type `Get-Help Format-List`.







RELATED LINKS

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

New-AzureRmDataFactoryGateway

Get-AzureRmDataFactoryGatewayAuthKey

New-AzureRmDataFactoryGatewayAuthKey