Skip to content

Latest commit

 

History

History
169 lines (127 loc) · 5.41 KB

Get-AzDataFactoryLinkedService.md

File metadata and controls

169 lines (127 loc) · 5.41 KB
Raw
external help file Module Name ms.assetid online version schema
Microsoft.Azure.PowerShell.Cmdlets.DataFactories.dll-Help.xml
Az.DataFactory
DFA41A2B-7C8A-42CB-B0B6-5E6FF853EFEE
2.0.0

Get-AzDataFactoryLinkedService

SYNOPSIS

Gets information about linked services in Azure Data Factory.

SYNTAX

ByFactoryName (Default)

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

ByFactoryObject

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: Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory
Parameter Sets: ByFactoryObject
Aliases:

Required: True
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: System.String
Parameter Sets: ByFactoryName
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-DefaultProfile

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

Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer
Parameter Sets: (All)
Aliases: AzContext, AzureRmContext, AzureCredential

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Name

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

Type: System.String
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
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: System.String
Parameter Sets: ByFactoryName
Aliases:

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

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

Microsoft.Azure.Commands.DataFactories.Models.PSDataFactory

System.String

OUTPUTS

Microsoft.Azure.Commands.DataFactories.Models.PSLinkedService

NOTES

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

RELATED LINKS

New-AzDataFactoryLinkedService

Remove-AzDataFactoryLinkedService