POST https://management.azure.com/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/executeDataFlowDebugCommand?api-version=2018-06-01
{
"commandPayload": {
"streamName": "source1",
"rowLimits": 100
},
"command": "executePreviewQuery",
"sessionId": "f06ed247-9d07-49b2-b05e-2cb4a2fc871e"
}
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: specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/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
from typing import Any, IO, Union
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="12345678-1234-1234-1234-12345678abc",
)
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: specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/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
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/v7"
)
// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/92de53a5f1e0e03c94b40475d2135d97148ed014/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/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("<subscription-id>", 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.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
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: specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/DataFlowDebugSession_ExecuteCommand.json
*/
async function dataFlowDebugSessionExecuteCommand() {
const subscriptionId =
process.env["DATAFACTORY_SUBSCRIPTION_ID"] || "12345678-1234-1234-1234-12345678abc";
const resourceGroupName = process.env["DATAFACTORY_RESOURCE_GROUP"] || "exampleResourceGroup";
const factoryName = "exampleFactoryName";
const request = {
command: "executePreviewQuery",
commandPayload: { rowLimits: 100, streamName: "source1" },
sessionId: "f06ed247-9d07-49b2-b05e-2cb4a2fc871e",
};
const credential = new DefaultAzureCredential();
const client = new DataFactoryManagementClient(credential, subscriptionId);
const result = await client.dataFlowDebugSession.beginExecuteCommandAndWait(
resourceGroupName,
factoryName,
request,
);
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
using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Core.Expressions.DataFactory;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.DataFactory;
using Azure.ResourceManager.DataFactory.Models;
using Azure.ResourceManager.Resources;
// Generated from example definition: specification/datafactory/resource-manager/Microsoft.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