< Back
New-AzureRmDataFactoryLinkedService
Post
NAME New-AzureRmDataFactoryLinkedService
SYNOPSIS
Links a data store or a cloud service to an Azure Data Factory.
SYNTAX
New-AzureRmDataFactoryLinkedService [-DataFactory] <PSDataFactory> [[-Name] <String>] [-File] <String> [-DefaultProfile <IAzureContextContainer>]
[-Force] [-Confirm] [-WhatIf] [<CommonParameters>]
New-AzureRmDataFactoryLinkedService [-ResourceGroupName] <String> [-DataFactoryName] <String> [[-Name] <String>] [-File] <String> [-DefaultProfile
<IAzureContextContainer>] [-Force] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The New-AzureRmDataFactoryLinkedService cmdlet links a data store or a cloud service to Azure Data Factory. If you specify a name for a linked
service that already exists, this cmdlet prompts you for confirmation before it replaces the linked service. If you specify the Force parameter,
the cmdlet replaces the existing linked service without confirmation.
Perform these operations in the following order:
- Create a data factory.
- Create linked services.
- Create datasets.
- Create a pipeline.
PARAMETERS
-DataFactory <PSDataFactory>
Specifies a PSDataFactory object. This cmdlet creates a linked service for the data factory that this parameter specifies.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DataFactoryName <String>
Specifies the name of a data factory. This cmdlet creates a linked service for 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
-File <String>
Specifies the full path of the JavaScript Object Notation (JSON) file that contains the description of the linked service.
Required? true
Position? 3
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Force [<SwitchParameter>]
Indicates that this cmdlet replaces an existing linked service without prompting you for confirmation.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Name <String>
Specifies the name of the linked service to create.
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 creates a linked service for the group that this parameter specifies.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
Accept pipeline input? False
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
None
This cmdlet does not accept any input.
OUTPUTS
Microsoft.WindowsAzure.Commands.Utilities.PSLinkedService
NOTES
* Keywords: azure, azurerm, arm, resource, management, manager, data, factories
Example 1: Create a linked service
PS C:\\>New-AzureRmDataFactoryLinkedService -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -Name "LinkedServiceCuratedWikiData" -File
"C:\\\\samples\\\\WikiSample\\\\LinkedServiceCuratedWikiData.json" | Format-List
LinkedServiceName : LinkedServiceCuratedWikiData
ResourceGroupName : ADF
DataFactoryName : WikiADF
Properties : Microsoft.DataFactories.AzureStorageLinkedService
This command creates a linked service named LinkedServiceCuratedWikiData in the data factory named WikiADF. This linked service links an Azure
blob store specified in the file to the data factory named WikiADF. The command passes the result 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`.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... kedservice
Get-AzureRmDataFactoryLinkedService
Remove-AzureRmDataFactoryLinkedService
SYNOPSIS
Links a data store or a cloud service to an Azure Data Factory.
SYNTAX
New-AzureRmDataFactoryLinkedService [-DataFactory] <PSDataFactory> [[-Name] <String>] [-File] <String> [-DefaultProfile <IAzureContextContainer>]
[-Force] [-Confirm] [-WhatIf] [<CommonParameters>]
New-AzureRmDataFactoryLinkedService [-ResourceGroupName] <String> [-DataFactoryName] <String> [[-Name] <String>] [-File] <String> [-DefaultProfile
<IAzureContextContainer>] [-Force] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The New-AzureRmDataFactoryLinkedService cmdlet links a data store or a cloud service to Azure Data Factory. If you specify a name for a linked
service that already exists, this cmdlet prompts you for confirmation before it replaces the linked service. If you specify the Force parameter,
the cmdlet replaces the existing linked service without confirmation.
Perform these operations in the following order:
- Create a data factory.
- Create linked services.
- Create datasets.
- Create a pipeline.
PARAMETERS
-DataFactory <PSDataFactory>
Specifies a PSDataFactory object. This cmdlet creates a linked service for the data factory that this parameter specifies.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DataFactoryName <String>
Specifies the name of a data factory. This cmdlet creates a linked service for 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
-File <String>
Specifies the full path of the JavaScript Object Notation (JSON) file that contains the description of the linked service.
Required? true
Position? 3
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Force [<SwitchParameter>]
Indicates that this cmdlet replaces an existing linked service without prompting you for confirmation.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Name <String>
Specifies the name of the linked service to create.
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 creates a linked service for the group that this parameter specifies.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
Accept pipeline input? False
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
None
This cmdlet does not accept any input.
OUTPUTS
Microsoft.WindowsAzure.Commands.Utilities.PSLinkedService
NOTES
* Keywords: azure, azurerm, arm, resource, management, manager, data, factories
Example 1: Create a linked service
PS C:\\>New-AzureRmDataFactoryLinkedService -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -Name "LinkedServiceCuratedWikiData" -File
"C:\\\\samples\\\\WikiSample\\\\LinkedServiceCuratedWikiData.json" | Format-List
LinkedServiceName : LinkedServiceCuratedWikiData
ResourceGroupName : ADF
DataFactoryName : WikiADF
Properties : Microsoft.DataFactories.AzureStorageLinkedService
This command creates a linked service named LinkedServiceCuratedWikiData in the data factory named WikiADF. This linked service links an Azure
blob store specified in the file to the data factory named WikiADF. The command passes the result 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`.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... kedservice
Get-AzureRmDataFactoryLinkedService
Remove-AzureRmDataFactoryLinkedService