New-AzDataFactoryLinkedService

Module:
Az.DataFactory

Links a data store or a cloud service to an Azure Data Factory.

Syntax

New-AzDataFactoryLinkedService
   [-DataFactoryName] <String>
   [[-Name] <String>]
   [-File] <String>
   [-Force]
   [-ResourceGroupName] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzDataFactoryLinkedService
   [-DataFactory] <PSDataFactory>
   [[-Name] <String>]
   [-File] <String>
   [-Force]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The New-AzDataFactoryLinkedService 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.

Examples

Example 1: Create a linked service

PS C:\>New-AzDataFactoryLinkedService -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.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False
-DataFactory

Specifies a PSDataFactory object. This cmdlet creates a linked service for the data factory that this parameter specifies.

Type:PSDataFactory
Position:0
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-DataFactoryName

Specifies the name of a data factory. This cmdlet creates a linked service for the data factory that this parameter specifies.

Type:String
Position:1
Default value:None
Accept pipeline input:True
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
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-File

Specifies the full path of the JavaScript Object Notation (JSON) file that contains the description of the linked service.

Type:String
Position:3
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Force

Indicates that this cmdlet replaces an existing linked service without prompting you for confirmation.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Name

Specifies the name of the linked service to create.

Type:String
Position:2
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-ResourceGroupName

Specifies the name of an Azure resource group. This cmdlet creates a linked service for the group that this parameter specifies.

Type:String
Position:0
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

PSDataFactory

String

Outputs

PSLinkedService

Notes

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