< Back
Get-AzureRmDataFactoryV2LinkedService
Post
NAME Get-AzureRmDataFactoryV2LinkedService
SYNOPSIS
Gets information about linked services in Data Factory.
SYNTAX
Get-AzureRmDataFactoryV2LinkedService [-DataFactory] <PSDataFactory> [[-Name] <String>] [-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzureRmDataFactoryV2LinkedService [-ResourceGroupName] <String> [-DataFactoryName] <String> [[-Name] <String>] [-DefaultProfile
<IAzureContextContainer>] [<CommonParameters>]
Get-AzureRmDataFactoryV2LinkedService [-DefaultProfile <IAzureContextContainer>] -ResourceId <String> [<CommonParameters>]
DESCRIPTION
The Get-AzureRmDataFactoryV2LinkedService 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.
PARAMETERS
-DataFactory <PSDataFactory>
Specifies a PSDataFactory object. This cmdlet gets linked services that belong to the data factory that this parameter specifies.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByValue)
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.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Name <String>
Specifies the name of the linked service about which to get information.
Required? false
Position? 2
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.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ResourceId <String>
The Azure resource ID.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
System.String
Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataFactory
OUTPUTS
System.Collections.Generic.List`1[[Microsoft.Azure.Commands.DataFactoryV2.Models.PSLinkedService, Microsoft.Azure.Commands.DataFactoryV2,
Version=0.1.9.0, Culture=neutral, PublicKeyToken=null]]
Microsoft.Azure.Commands.DataFactoryV2.Models.PSLinkedService
NOTES
Keywords: azure, azurerm, arm, resource, management, manager, data, factories
Example 1: Get information about all linked services
PS C:\\> Get-AzureRmDataFactoryV2LinkedService -ResourceGroupName "ADF" -DataFactoryName "WikiADF" | Format-List
LinkedServiceName : LinkedServiceCuratedWikiData
ResourceGroupName : ADF
DataFactoryName : WikiADF
Properties : Microsoft.Azure.Management.DataFactory.Models.AzureStorageLinkedService
LinkedServiceName : LinkedServiceHDIStorage
ResourceGroupName : ADF
DataFactoryName : WikiADF
Properties : Microsoft.Azure.Management.DataFactory.Models.AzureStorageLinkedService
LinkedServiceName : LinkedServiceWikipediaClickEvents
ResourceGroupName : ADF
DataFactoryName : WikiADF
Properties : Microsoft.Azure.Management.DataFactory.Models.AzureStorageLinkedService
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:
Example 2: Get information about a specific linked service
PS C:\\> Get-AzureRmDataFactoryV2LinkedService -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -Name "LinkedServiceCuratedWikiData"
LinkedServiceName : LinkedServiceCuratedWikiData
ResourceGroupName : ADF
DataFactoryName : WikiADF
Properties : Microsoft.Azure.Management.DataFactory.Models.AzureStorageLinkedService
This command gets information about the linked service named LinkedServiceCuratedWikiData in the data factory named WikiADF.
Example 3: Get information about a specific linked service by specifying the DataFactory parameter
PS C:\\>$DataFactory = Get-AzureRmDataFactoryV2 -ResourceGroupName "ADF" -Name "ContosoFactory"PS C:\\> Get-AzureRmDataFactoryV2LinkedService
-DataFactory $DataFactory | Format-Table -Property LinkedServiceName, DataFactoryName, ResourceGroupName
The first command uses the Get-AzureRmDataFactoryV2 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 dataset with the specified properties as
dataset columns.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... kedservice
Set-AzureRmDataFactoryV2LinkedService
Remove-AzureRmDataFactoryV2LinkedService
SYNOPSIS
Gets information about linked services in Data Factory.
SYNTAX
Get-AzureRmDataFactoryV2LinkedService [-DataFactory] <PSDataFactory> [[-Name] <String>] [-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzureRmDataFactoryV2LinkedService [-ResourceGroupName] <String> [-DataFactoryName] <String> [[-Name] <String>] [-DefaultProfile
<IAzureContextContainer>] [<CommonParameters>]
Get-AzureRmDataFactoryV2LinkedService [-DefaultProfile <IAzureContextContainer>] -ResourceId <String> [<CommonParameters>]
DESCRIPTION
The Get-AzureRmDataFactoryV2LinkedService 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.
PARAMETERS
-DataFactory <PSDataFactory>
Specifies a PSDataFactory object. This cmdlet gets linked services that belong to the data factory that this parameter specifies.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByValue)
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.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Name <String>
Specifies the name of the linked service about which to get information.
Required? false
Position? 2
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.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ResourceId <String>
The Azure resource ID.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
System.String
Microsoft.Azure.Commands.DataFactoryV2.Models.PSDataFactory
OUTPUTS
System.Collections.Generic.List`1[[Microsoft.Azure.Commands.DataFactoryV2.Models.PSLinkedService, Microsoft.Azure.Commands.DataFactoryV2,
Version=0.1.9.0, Culture=neutral, PublicKeyToken=null]]
Microsoft.Azure.Commands.DataFactoryV2.Models.PSLinkedService
NOTES
Keywords: azure, azurerm, arm, resource, management, manager, data, factories
Example 1: Get information about all linked services
PS C:\\> Get-AzureRmDataFactoryV2LinkedService -ResourceGroupName "ADF" -DataFactoryName "WikiADF" | Format-List
LinkedServiceName : LinkedServiceCuratedWikiData
ResourceGroupName : ADF
DataFactoryName : WikiADF
Properties : Microsoft.Azure.Management.DataFactory.Models.AzureStorageLinkedService
LinkedServiceName : LinkedServiceHDIStorage
ResourceGroupName : ADF
DataFactoryName : WikiADF
Properties : Microsoft.Azure.Management.DataFactory.Models.AzureStorageLinkedService
LinkedServiceName : LinkedServiceWikipediaClickEvents
ResourceGroupName : ADF
DataFactoryName : WikiADF
Properties : Microsoft.Azure.Management.DataFactory.Models.AzureStorageLinkedService
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:
Example 2: Get information about a specific linked service
PS C:\\> Get-AzureRmDataFactoryV2LinkedService -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -Name "LinkedServiceCuratedWikiData"
LinkedServiceName : LinkedServiceCuratedWikiData
ResourceGroupName : ADF
DataFactoryName : WikiADF
Properties : Microsoft.Azure.Management.DataFactory.Models.AzureStorageLinkedService
This command gets information about the linked service named LinkedServiceCuratedWikiData in the data factory named WikiADF.
Example 3: Get information about a specific linked service by specifying the DataFactory parameter
PS C:\\>$DataFactory = Get-AzureRmDataFactoryV2 -ResourceGroupName "ADF" -Name "ContosoFactory"PS C:\\> Get-AzureRmDataFactoryV2LinkedService
-DataFactory $DataFactory | Format-Table -Property LinkedServiceName, DataFactoryName, ResourceGroupName
The first command uses the Get-AzureRmDataFactoryV2 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 dataset with the specified properties as
dataset columns.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... kedservice
Set-AzureRmDataFactoryV2LinkedService
Remove-AzureRmDataFactoryV2LinkedService