Skip to content

Latest commit

 

History

History
171 lines (130 loc) · 4.33 KB

New-AzDataFactoryGateway.md

File metadata and controls

171 lines (130 loc) · 4.33 KB
external help file Module Name ms.assetid online version schema
Microsoft.Azure.PowerShell.Cmdlets.DataFactories.dll-Help.xml
Az.DataFactory
4DCF54BA-CFFA-4555-8CA3-66B98F704EFB
2.0.0

New-AzDataFactoryGateway

SYNOPSIS

Creates a gateway for an Azure Data Factory.

SYNTAX

ByFactoryName (Default)

New-AzDataFactoryGateway [-DataFactoryName] <String> [-Name] <String> [[-Description] <String>]
 [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]

ByFactoryObject

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

DESCRIPTION

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

EXAMPLES

Example 1: Create a gateway

New-AzDataFactoryGateway -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#Y9R0NhAeH3u7wgnrJyiWj4Y/QIhH4fFilIdzZgwsVQA=

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

PARAMETERS

-DataFactory

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

Type: Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory
Parameter Sets: ByFactoryObject
Aliases:

Required: True
Position: 0
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 for the data factory that this parameter specifies.

Type: System.String
Parameter Sets: ByFactoryName
Aliases:

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

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with azure

Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer
Parameter Sets: (All)
Aliases: AzContext, AzureRmContext, AzureCredential

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Description

Specifies a description for the gateway.

Type: System.String
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Name

Specifies the name of the gateway to create.

Type: System.String
Parameter Sets: (All)
Aliases:

Required: True
Position: 2
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 gateway that belongs to the group that this parameter specifies.

Type: System.String
Parameter Sets: ByFactoryName
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. 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.PSDataFactoryGateway

NOTES

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

RELATED LINKS

Remove-AzDataFactoryGateway

Set-AzDataFactoryGateway