Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Get-AzureDataFactoryGateway

Get-AzureDataFactoryGateway

microsoft.azure.commands.datafactories.dll

Synopsis

Gets information about logical gateways in Data Factory.

Syntax

Get-AzureDataFactoryGateway [-ResourceGroupName] [-DataFactoryName] [-Name] [<CommonParameters>]

Get-AzureDataFactoryGateway [-DataFactory] [-Name] [<CommonParameters>]

Detailed Description

The Get-AzureDataFactoryGateway cmdlet gets information about logical gateways in Azure Data Factory. If you specify the name of a gateway, this cmdlet gets information about that gateway. If you do not specify a name, this cmdlet gets information about all gateways for a data factory.

If you want to add an on-premises MicrosoftSQL Server as a linked service to a data factory, you must install a gateway on your on-premises computer.

You must be in AzureResourceManager mode to run Azure Data Factory cmdlets. To switch to AzureResourceManager mode, type Switch-AzureMode AzureResourceManager.

Parameters

-DataFactory <PSDataFactory>

Specifies a PSDataFactory object. This cmdlet gets information about logical gateways in the data factory that this parameter specifies.

Aliases

None

Required?

true

Position

1

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-DataFactoryName <String>

Specifies the name of a data factory. This cmdlet gets information about logical gateways in the data factory that this parameter specifies.

Aliases

None

Required?

true

Position

2

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-Name <String>

Specifies the name of the logical gateway about which to get information.

Aliases

None

Required?

false

Position

3

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-ResourceGroupName <String>

Specifies the name of an Azure resource group. This cmdlet gets information about logical gateways that belong to the group that this parameter specifies.

Aliases

None

Required?

true

Position

1

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

Input Type


Return Type

System.Collections.Generic.List`1[[Microsoft.WindowsAzure.Commands.Utilities.PSDataFactoryGateway]], Microsoft.WindowsAzure.Commands.Utilities.PSDataFactoryGateway

Notes

None

Examples

Example 1: Get all logical gateways in a data factory

This command gets information about all logical gateways for the data factory named WikiADF in the resource group named ADF.

                    PS C:\> Get-AzureDataFactoryGateway -ResourceGroupName "ADF" -DataFactoryName "WikiADF"
                    Name            : gateway1
                    Description     :
                    Version         : 1.3.5338.1
                    Status          : Online
                    VersionStatus   : UpToDate
                    CreateTime      : 8/22/2014 1:40:34 AM
                    RegisterTime    : 8/22/2014 1:41:46 AM
                    LastConnectTime : 8/22/2014 1:44:56 AM
                    ExpiryTime      :

                    Name            : gateway2
                    Description     :
                    Version         : 1.3.5338.1
                    Status          : Offline
                    VersionStatus   : UpToDate
                    CreateTime      : 8/29/2014 1:46:44 AM
                    RegisterTime    : 8/29/2014 1:48:36 AM
                    LastConnectTime : 8/29/2014 1:56:56 AM
                    ExpiryTime      :
                

Example 2: Get a specific logical gateway in a data factory

This command gets information about the logical gateway named Gateway01 in the data factory named WikiADF in the resource group named ADF.

                    PS C:\> Get-AzureDataFactoryGateway -ResourceGroupName "ADF" -Name "Gateway01" -DataFactoryName "WikiADF"
                    Name            : Gateway01
                    Description     :
                    Version         : 1.3.5338.1
                    Status          : Online
                    VersionStatus   : UpToDate
                    CreateTime      : 8/22/2014 1:40:34 AM
                    RegisterTime    : 8/22/2014 1:41:46 AM
                    LastConnectTime : 8/22/2014 1:44:56 AM
                    ExpiryTime      :
                

New-AzureDataFactoryGateway
Remove-AzureDataFactoryGateway
Set-AzureDataFactoryGateway