Get-​Azure​Rm​Data​Factory​Linked​Service

Gets information about linked services in Azure Data Factory.

Syntax

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

Description

The Get-AzureRmDataFactoryLinkedService cmdlet gets information about linked services in Azure Data Factory. If you specify the name of a linked service, this cmdlet gets information about that linked service. If you do not specify a name, this cmdlet gets information about all the linked services in the data factory.

Examples

Example 1: Get information about all linked services

PS C:\>Get-AzureRmDataFactoryLinkedService -ResourceGroupName "ADF" -DataFactoryName "WikiADF" | Format-List

This command gets information about all linked services in the data factory named WikiADF, and then passes the linked services to the Format-List cmdlet by using the pipeline operator. That cmdlet formats the results. For more information, type Get-Help Format-List.

Example 2: Get information about a specific linked service

PS C:\>Get-AzureRmDataFactoryLinkedService -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -Name "HDILinkedService"
LinkedServiceName   ResourceGroupName     DataFactoryName              Properties
-----------------   -----------------     ---------------              ----------
HDILinkedService    ADF                   WikiADF                      Microsoft.DataFactories.HDInsightBYOCAsset

This command gets information about the linked service named HDILinkedService in the data factory named WikiADF.

Example 3: Get information about a specific linked service by specifying the DataFactory parameter

PS C:\>$DataFactory = Get-AzureRmDataFactory -ResourceGroupName "ADF" -Name "ContosoFactory"
PS C:\> Get-AzureRmDataFactoryLinkedService -DataFactory $DataFactory | Format-Table -Property LinkedServiceName, DataFactoryName, ResourceGroupName

The first command uses the Get-AzureRmDataFactory cmdlet to get the data factory named ContosoFactory, and then stores it in the $DataFactory variable.

The second command gets information about the linked service for the data factory stored in $DataFactory, and then passes that information to the Format-Table cmdlet by using the pipeline operator. Format-Table formats the output as a dataset with the specified properties as dataset columns.

Required Parameters

-DataFactory

Specifies a PSDataFactory object. This cmdlet gets linked services that belong to 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 linked services that belong to 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 linked services 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 linked service 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.PSLinkedService, Microsoft.WindowsAzure.Commands.Utilities, Version=0.8.2.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]] Microsoft.WindowsAzure.Commands.Utilities.PSLinkedService

Notes

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