Data Flow Debug Session - Execute Command

Service:

Data Factory

API Version:

2018-06-01

Execute a data flow debug command.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/executeDataFlowDebugCommand?api-version=2018-06-01

URI Parameters

Name	In	Required	Type	Description
factoryName	path	True	string minLength: 3 maxLength: 63 pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$	The factory name.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string (uuid)	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Request Body

Name	Type	Description
command	DataFlowDebugCommandType	The command type.
commandPayload	DataFlowDebugCommandPayload	The command payload object.
sessionId	string	The ID of data flow debug session.

Responses

Name	Type	Description
200 OK	DataFlowDebugCommandResponse	Azure operation completed successfully.
202 Accepted		Resource operation accepted. Headers Location: string Retry-After: integer
Other Status Codes	CloudError	An unexpected error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

DataFlowDebugSession_ExecuteCommand

Sample request

HTTP

POST https://management.azure.com/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/executeDataFlowDebugCommand?api-version=2018-06-01

{
  "command": "executePreviewQuery",
  "commandPayload": {
    "rowLimits": 100,
    "streamName": "source1"
  },
  "sessionId": "f06ed247-9d07-49b2-b05e-2cb4a2fc871e"
}

Java

import com.azure.resourcemanager.datafactory.models.DataFlowDebugCommandPayload;
import com.azure.resourcemanager.datafactory.models.DataFlowDebugCommandRequest;
import com.azure.resourcemanager.datafactory.models.DataFlowDebugCommandType;

/**
 * Samples for DataFlowDebugSession ExecuteCommand.
 */
public final class Main {
    /*
     * x-ms-original-file: 2018-06-01/DataFlowDebugSession_ExecuteCommand.json
     */
    /**
     * Sample code: DataFlowDebugSession_ExecuteCommand.
     * 
     * @param manager Entry point to DataFactoryManager.
     */
    public static void
        dataFlowDebugSessionExecuteCommand(com.azure.resourcemanager.datafactory.DataFactoryManager manager) {
        manager.dataFlowDebugSessions().executeCommand("exampleResourceGroup", "exampleFactoryName",
            new DataFlowDebugCommandRequest().withSessionId("f06ed247-9d07-49b2-b05e-2cb4a2fc871e")
                .withCommand(DataFlowDebugCommandType.EXECUTE_PREVIEW_QUERY)
                .withCommandPayload(new DataFlowDebugCommandPayload().withStreamName("source1").withRowLimits(100)),
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.datafactory import DataFactoryManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-datafactory
# USAGE
    python data_flow_debug_session_execute_command.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = DataFactoryManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.data_flow_debug_session.begin_execute_command(
        resource_group_name="exampleResourceGroup",
        factory_name="exampleFactoryName",
        request={
            "command": "executePreviewQuery",
            "commandPayload": {"rowLimits": 100, "streamName": "source1"},
            "sessionId": "f06ed247-9d07-49b2-b05e-2cb4a2fc871e",
        },
    ).result()
    print(response)


# x-ms-original-file: 2018-06-01/DataFlowDebugSession_ExecuteCommand.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armdatafactory_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/datafactory/armdatafactory/v11"
)

// Generated from example definition: 2018-06-01/DataFlowDebugSession_ExecuteCommand.json
func ExampleDataFlowDebugSessionClient_BeginExecuteCommand() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdatafactory.NewClientFactory("12345678-1234-1234-1234-123456789012", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewDataFlowDebugSessionClient().BeginExecuteCommand(ctx, "exampleResourceGroup", "exampleFactoryName", armdatafactory.DataFlowDebugCommandRequest{
		Command: to.Ptr(armdatafactory.DataFlowDebugCommandTypeExecutePreviewQuery),
		CommandPayload: &armdatafactory.DataFlowDebugCommandPayload{
			RowLimits:  to.Ptr[int32](100),
			StreamName: to.Ptr("source1"),
		},
		SessionID: to.Ptr("f06ed247-9d07-49b2-b05e-2cb4a2fc871e"),
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armdatafactory.DataFlowDebugSessionClientExecuteCommandResponse{
	// 	DataFlowDebugCommandResponse: &armdatafactory.DataFlowDebugCommandResponse{
	// 		Data: to.Ptr("some output"),
	// 		Status: to.Ptr("Succeeded"),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { DataFactoryManagementClient } = require("@azure/arm-datafactory");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to execute a data flow debug command.
 *
 * @summary execute a data flow debug command.
 * x-ms-original-file: 2018-06-01/DataFlowDebugSession_ExecuteCommand.json
 */
async function dataFlowDebugSessionExecuteCommand() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "12345678-1234-1234-1234-123456789012";
  const client = new DataFactoryManagementClient(credential, subscriptionId);
  const result = await client.dataFlowDebugSession.executeCommand(
    "exampleResourceGroup",
    "exampleFactoryName",
    {
      command: "executePreviewQuery",
      commandPayload: { rowLimits: 100, streamName: "source1" },
      sessionId: "f06ed247-9d07-49b2-b05e-2cb4a2fc871e",
    },
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.DataFactory.Models;
using Azure.ResourceManager.DataFactory;

// Generated from example definition: specification/datafactory/resource-manager/Microsoft.DataFactory/DataFactory/stable/2018-06-01/examples/DataFlowDebugSession_ExecuteCommand.json
// this example is just showing the usage of "DataFlowDebugSession_ExecuteCommand" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this DataFactoryResource created on azure
// for more information of creating DataFactoryResource, please refer to the document of DataFactoryResource
string subscriptionId = "12345678-1234-1234-1234-12345678abc";
string resourceGroupName = "exampleResourceGroup";
string factoryName = "exampleFactoryName";
ResourceIdentifier dataFactoryResourceId = DataFactoryResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, factoryName);
DataFactoryResource dataFactory = client.GetDataFactoryResource(dataFactoryResourceId);

// invoke the operation
DataFlowDebugCommandContent content = new DataFlowDebugCommandContent
{
    SessionId = Guid.Parse("f06ed247-9d07-49b2-b05e-2cb4a2fc871e"),
    Command = DataFlowDebugCommandType.ExecutePreviewQuery,
    CommandPayload = new DataFlowDebugCommandPayload("source1")
    {
        RowLimits = 100,
    },
};
ArmOperation<DataFactoryDataFlowDebugCommandResult> lro = await dataFactory.ExecuteDataFlowDebugSessionCommandAsync(WaitUntil.Completed, content);
DataFactoryDataFlowDebugCommandResult result = lro.Value;

Console.WriteLine($"Succeeded: {result}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:

200

{
  "data": "some output",
  "status": "Succeeded"
}

Status code:

202

Date: Sat, 16 Jun 2018 00:40:01 GMT
X-Content-Type-Options: nosniff
location: https://management.azure.com/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/operationResults/dfCommandOutput$$f06ed247-9d07-49b2-b05e-2cb4a2fc871e$$e5328ee7-c524-4207-8ba4-b709010db33d$$ace5eaf0-3e93-45ba-ada3-bf77da321a7b?api-version=2018-06-01
x-ms-correlation-request-id: 2f955e10-c6df-45a7-97d4-81acdb8540cd
x-ms-ratelimit-remaining-subscription-reads: 14989
x-ms-request-id: 2f955e10-c6df-45a7-97d4-81acdb8540cd

Definitions

Name	Description
CloudError	The object that defines the structure of an Azure Data Factory error response.
DataFlowDebugCommandPayload	Structure of command payload.
DataFlowDebugCommandRequest	Request body structure for data flow debug command.
DataFlowDebugCommandResponse	Response body structure of data flow result for data preview, statistics or expression preview.
DataFlowDebugCommandType	The command type.

CloudError

Object

The object that defines the structure of an Azure Data Factory error response.

Name	Type	Description
error.code	string	Error code.
error.details	CloudError[]	Array with additional error details.
error.message	string	Error message.
error.target	string	Property name/path in request associated with error.

DataFlowDebugCommandPayload

Object

Structure of command payload.

Name	Type	Description
columns	string[]	Array of column names.
expression	string	The expression which is used for preview.
rowLimits	integer (int32)	Row limits for preview response.
streamName	string	The stream name which is used for preview.

DataFlowDebugCommandRequest

Object

Request body structure for data flow debug command.

Name	Type	Description
command	DataFlowDebugCommandType	The command type.
commandPayload	DataFlowDebugCommandPayload	The command payload object.
sessionId	string	The ID of data flow debug session.

DataFlowDebugCommandResponse

Object

Response body structure of data flow result for data preview, statistics or expression preview.

Name	Type	Description
data	string	The result data of data preview, statistics or expression preview.
status	string	The run status of data preview, statistics or expression preview.

DataFlowDebugCommandType

Enumeration

The command type.

Value	Description
executePreviewQuery	executePreviewQuery
executeStatisticsQuery	executeStatisticsQuery
executeExpressionQuery	executeExpressionQuery