Edit

Get-AzDataFactoryLinkedService

  • Reference
Module:
Az.DataFactory

Gets information about linked services in Azure Data Factory.

Syntax

Get-AzDataFactoryLinkedService
   [-DataFactoryName] <String>
   [[-Name] <String>]
   [-ResourceGroupName] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzDataFactoryLinkedService
   [-DataFactory] <PSDataFactory>
   [[-Name] <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The Get-AzDataFactoryLinkedService 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

Get-AzDataFactoryLinkedService -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

Get-AzDataFactoryLinkedService -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

$DataFactory = Get-AzDataFactory -ResourceGroupName "ADF" -Name "ContosoFactory"
Get-AzDataFactoryLinkedService -DataFactory $DataFactory | Format-Table -Property LinkedServiceName, DataFactoryName, ResourceGroupName

The first command uses the Get-AzDataFactory 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.

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
Required:True
Accept pipeline input:True
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
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-DefaultProfile

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

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Name

Specifies the name of the linked service about which to get information.

Type:String
Position:2
Default value:None
Required:False
Accept pipeline input:True
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
Required:True
Accept pipeline input:True
Accept wildcard characters:False

Inputs

PSDataFactory

String

Outputs

PSLinkedService

Notes

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