New-​Azure​Rm​Data​Factory​Gateway​Key

Creates a gateway key for an Azure Data Factory.

Syntax

New-AzureRmDataFactoryGatewayKey
   [-DataFactory] <PSDataFactory>
   [-GatewayName] <String>
   [<CommonParameters>]
New-AzureRmDataFactoryGatewayKey
   [-ResourceGroupName] <String>
   [-DataFactoryName] <String>
   [-GatewayName] <String>
   [<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.

Examples

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#Y9R0NhAeH3u7wgnrJyiWj4Y/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.

Required Parameters

-DataFactory

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

Type:PSDataFactory
Position:1
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-DataFactoryName

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

Type:String
Position:2
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-GatewayName

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

Type:String
Position:3
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-ResourceGroupName

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.

Type:String
Position:1
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Outputs

Microsoft.WindowsAzure.Commands.Utilities.PSDataFactoryGatewayKey

Notes

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