Azure Batch 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 Batch 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 Batch linked service to link an Azure Batch pool of virtual machines (VMs) to an Azure data factory. This topic describes the JSON properties for defining an Azure Batch 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.

You can run .NET custom activities using either Azure Batch or Azure HDInsight. To use Azure Batch to run the custom activity:

1. Create a linked service of type AzureBatchLinkedService.

2. Associate this linked service with the custom activity. You do this by specifying the linked service as the value for the linkedServiceName property in the activity definition of pipeline JSON.

See following topics if you are new to Azure Batch service:

• Azure Batch Technical Overview for an overview of the Azure Batch service.

•  New-AzureBatchAccount cmdlet to create an Azure Batch account (or) Azure Management Portal to create the Azure Batch account using Azure Management Portal. See Using PowerShell to manage Azure Batch Account topic for detailed instructions on using the cmdlet.

•  New-AzureBatchPool cmdlet to create an Azure Batch pool.

Properties

Property	Description
type	The type property should be set to AzureBatchLinkedService.
accountName	Name of the Azure Batch account.
accessKey	Access key for the Azure Batch account.
poolName	Name of the pool of virtual machines.
linkedServiceName	Name of the Azure Storage linked service associated with this Azure Batch linked service. This linked service is used for staging files required to run the activity and storing the activity execution logs.

Example

{
    "name": "AzureBatchLinkedService",
    "properties": {
        "type": "AzureBatchLinkedService",
        "accountName": "<Azure Batch account name>",
        "accessKey": "<Azure Batch account key>",
        "poolName": "<Azure Batch pool name>",
        "linkedServiceName": "<Specify associated storage linked service reference here>"
    }
}

See Use custom activities in an Azure Data Factory pipeline article for more details.

See Also

Azure Data Factory Updates: Execute ADF Custom .NET activities using Azure Batch