< Back

New-AzureRmDataFactoryGateway

Tue Jan 29, 2019 9:41 pm

NAME New-AzureRmDataFactoryGateway



SYNOPSIS

Creates a gateway for an Azure Data Factory.





SYNTAX

New-AzureRmDataFactoryGateway [-DataFactory] <PSDataFactory> [-Name] <String> [[-Description] <String>] [-DefaultProfile <IAzureContextContainer>]

[<CommonParameters>]



New-AzureRmDataFactoryGateway [-ResourceGroupName] <String> [-DataFactoryName] <String> [-Name] <String> [[-Description] <String>]

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





DESCRIPTION

The New-AzureRmDataFactoryGateway cmdlet creates a gateway in Azure Data Factory.





PARAMETERS

-DataFactory <PSDataFactory>

Specifies a PSDataFactory object. This cmdlet creates a gateway 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 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



-Description <String>

Specifies a description for the gateway.



Required? false

Position? 3

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Name <String>

Specifies the name of the gateway to create.



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 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.Azure.Commands.DataFactories.Models.PSDataFactoryGateway







NOTES





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



Example 1: Create a gateway



PS C:\\>New-AzureRmDataFactoryGateway -ResourceGroupName "ADF" -Name "ContosoGateway" -DataFactoryName "WikiADF" -Description "my gateway"

Name : ContosoGateway

Description : my gateway

Version :

Status : NeedRegistration

VersionStatus : None

CreateTime : 8/22/2014 1:40:34 AM

RegisterTime :

LastConnectTime :

ExpiryTime :

ProvisioningState : Succeeded

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

3u7wgnrJyiWj4Y/QIhH4fFilIdzZgwsVQA=



This command creates a gateway named ContosoGateway in the data factory named WikiADF in the resource group named ADF.







RELATED LINKS

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

Remove-AzureRmDataFactoryGateway

Set-AzureRmDataFactoryGateway