Get-AzDataFactoryGateway
Gets information about logical gateways in Azure Data Factory.
Syntax
ByFactoryName (Default)
Get-AzDataFactoryGateway
[-DataFactoryName] <String>
[[-Name] <String>]
[-ResourceGroupName] <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
ByFactoryObject
Get-AzDataFactoryGateway
[-DataFactory] <PSDataFactory>
[[-Name] <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
The Get-AzDataFactoryGateway 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
Get-AzDataFactoryGateway -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
Get-AzDataFactoryGateway -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.
Parameters
-DataFactory
Specifies a PSDataFactory object. This cmdlet gets information about logical gateways in the data factory that this parameter specifies.
Parameter properties
| Type: | PSDataFactory |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ByFactoryObject
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-DataFactoryName
Specifies the name of a data factory. This cmdlet gets information about logical gateways in the data factory that this parameter specifies.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ByFactoryName
| Position: | 1 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with azure
Parameter properties
| Type: | IAzureContextContainer |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Name
Specifies the name of the logical gateway about which to get information.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 2 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ByFactoryName
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
PSDataFactory
String
Outputs
PSDataFactoryGateway
Notes
- Keywords: azure, azurerm, arm, resource, management, manager, data, factories