< Back
Set-AzureRmDataFactoryV2LinkedService
Post
NAME Set-AzureRmDataFactoryV2LinkedService
SYNOPSIS
Links a data store or a cloud service to Data Factory.
SYNTAX
Set-AzureRmDataFactoryV2LinkedService [-ResourceGroupName] <String> [-DataFactoryName] <String> [-Name] <String> [-DefinitionFile] <String>
[-DefaultProfile <IAzureContextContainer>] [-Force] [-Confirm] [-WhatIf] [<CommonParameters>]
Set-AzureRmDataFactoryV2LinkedService [-ResourceId] <String> [-DefinitionFile] <String> [-DefaultProfile <IAzureContextContainer>] [-Force]
[-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Set-AzureRmDataFactoryV2LinkedService 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
-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
-DefinitionFile <String>
The JSON file path.
Required? true
Position? 3
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Force [<SwitchParameter>]
Runs the cmdlet without prompting 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? true
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
-ResourceId <String>
The Azure resource ID.
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 happens if the cmdlet runs, but doesn't run the cmdlet.
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
System.String
OUTPUTS
Microsoft.Azure.Commands.DataFactoryV2.Models.PSLinkedService
NOTES
Keywords: azure, azurerm, arm, resource, management, manager, data, factories
Example 1: Create a linked service
PS C:\\> Set-AzureRmDataFactoryV2LinkedService -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -Name "LinkedServiceCuratedWikiData" -File
"C:\\\\samples\\\\WikiSample\\\\LinkedServiceCuratedWikiData.json" | Format-List
LinkedServiceName : LinkedServiceCuratedWikiData
ResourceGroupName : ADF
DataFactoryName : WikiADF
Properties : Microsoft.Azure.Management.DataFactory.Models.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-AzureRmDataFactoryV2LinkedService
Remove-AzureRmDataFactoryV2LinkedService
SYNOPSIS
Links a data store or a cloud service to Data Factory.
SYNTAX
Set-AzureRmDataFactoryV2LinkedService [-ResourceGroupName] <String> [-DataFactoryName] <String> [-Name] <String> [-DefinitionFile] <String>
[-DefaultProfile <IAzureContextContainer>] [-Force] [-Confirm] [-WhatIf] [<CommonParameters>]
Set-AzureRmDataFactoryV2LinkedService [-ResourceId] <String> [-DefinitionFile] <String> [-DefaultProfile <IAzureContextContainer>] [-Force]
[-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Set-AzureRmDataFactoryV2LinkedService 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
-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
-DefinitionFile <String>
The JSON file path.
Required? true
Position? 3
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Force [<SwitchParameter>]
Runs the cmdlet without prompting 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? true
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
-ResourceId <String>
The Azure resource ID.
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 happens if the cmdlet runs, but doesn't run the cmdlet.
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
System.String
OUTPUTS
Microsoft.Azure.Commands.DataFactoryV2.Models.PSLinkedService
NOTES
Keywords: azure, azurerm, arm, resource, management, manager, data, factories
Example 1: Create a linked service
PS C:\\> Set-AzureRmDataFactoryV2LinkedService -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -Name "LinkedServiceCuratedWikiData" -File
"C:\\\\samples\\\\WikiSample\\\\LinkedServiceCuratedWikiData.json" | Format-List
LinkedServiceName : LinkedServiceCuratedWikiData
ResourceGroupName : ADF
DataFactoryName : WikiADF
Properties : Microsoft.Azure.Management.DataFactory.Models.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-AzureRmDataFactoryV2LinkedService
Remove-AzureRmDataFactoryV2LinkedService