Get-​Azure​Rm​Data​Factory​Gateway

Gets information about logical gateways in Azure Data Factory.

Syntax

Get-AzureRmDataFactoryGateway
   [-DataFactory] <PSDataFactory>
   [[-Name] <String>]
   [<CommonParameters>]
Get-AzureRmDataFactoryGateway
   [-ResourceGroupName] <String>
   [-DataFactoryName] <String>
   [[-Name] <String>]
   [<CommonParameters>]

Description

The Get-AzureRmDataFactoryGateway 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 Microsoft SQL Server as a linked service to a data factory, you must install a gateway on your on-premises computer.

Examples

Example 1: Get all logical gateways in a data factory

PS C:\>Get-AzureRmDataFactoryGateway -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      :

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

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

PS C:\>Get-AzureRmDataFactoryGateway -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      :

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

Required Parameters

-DataFactory

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

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

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

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

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

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

Optional Parameters

-Name

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

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

Outputs

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

Notes

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