Azure HDInsight BYOC Linked Service

 

Important

This topic provides the JSON format that is supported by the older versions of Azure PowerShell. If you are using the July 2015 Release version of Azure PowerShell or later, see Azure HDInsight Linked Service for the latest JSON format. You can convert the JSON from old format to new format by using the tool: JSON Upgrade Tool

You create an Azure HDInsight BYOC (bring-your-own-cluster) linked service to link your own Azure HDInsight cluster to an Azure data factory. This topic describes the JSON properties for defining a HDInsight linked service. When you use the Data Factory Editor in Azure Portal, the editor provides you a JSON template for defining a linked service that you can modify and deploy to create a linked service. To use the T:Microsoft.Azure.Commands.DataFactories.New-AzureDataFactoryLinkedService cmdlet to create a linked service, you will need to create a JSON file and use it with the cmdlet.

Important

This topic provides the JSON format that you can use to define an Azure HDInsight BYOC linked service with old versions of API (prior to 2015-05-01-preview). If you are using the newer/latest version of API, see Azure HDInsight Linked Service for the new/latest JSON format.

Properties

Property	Description
type	The type property should be set to HDInsightBYOCLinkedService.
clusterUri	The URI of the HDInsight cluster.
username	Specify username to be used to connect to an existing HDInsight cluster.
password	Specify password for the user account.
location	Specify the location of the HDInsight cluster (for example: WestUS).
linkedServiceName	Name of the linked service for the blob storage used by this HDInsight cluster.

Example

{
    "name": "MyHDInsightLinkedService",
    "properties":
    {
        "type": "HDInsightBYOCLinkedService",
        "clusterUri": " https://<hdinsightclustername>.azurehdinsight.net/",
        "userName": "admin",
        "password": "<password>",
        "location": "WestUS",
        "linkedServiceName": "MyHDInsightStoragelinkedService"
    }
}