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-AzureDataFactoryLinkedService

Get-AzureDataFactoryLinkedService

microsoft.azure.commands.datafactories.dll

Synopsis

Gets information about linked services in Data Factory.

Syntax

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

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

Detailed Description

The Get-AzureDataFactoryLinkedService 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.

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

Notes

None

Examples

Example 1: Get information about all linked services

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 Windows PowerShell cmdlet formats the results. For more information, type Get-Help Format-List.

You can use either one of the following ways:

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

Example 2: Get information about a specific linked service

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

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

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

The first command uses the Get-AzureDataFactory 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. The Format-Table cmdlet formats the output as a table with the specified properties as table columns.

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

New-AzureDataFactoryLinkedService
Remove-AzureDataFactoryLinkedService