Data Flow Debug Session - Query By Factory

Service:

Data Factory

API Version:

2018-06-01

Query all active data flow debug sessions.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/queryDataFlowDebugSessions?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.

Responses

Name	Type	Description
200 OK	QueryDataFlowDebugSessionsResponse	Azure operation completed successfully.
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_QueryByFactory

Sample request

HTTP

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

Java

/**
 * Samples for DataFlowDebugSession QueryByFactory.
 */
public final class Main {
    /*
     * x-ms-original-file: 2018-06-01/DataFlowDebugSession_QueryByFactory.json
     */
    /**
     * Sample code: DataFlowDebugSession_QueryByFactory.
     * 
     * @param manager Entry point to DataFactoryManager.
     */
    public static void
        dataFlowDebugSessionQueryByFactory(com.azure.resourcemanager.datafactory.DataFactoryManager manager) {
        manager.dataFlowDebugSessions().queryByFactory("exampleResourceGroup", "exampleFactoryName",
            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_query_by_factory.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.query_by_factory(
        resource_group_name="exampleResourceGroup",
        factory_name="exampleFactoryName",
    )
    for item in response:
        print(item)


# x-ms-original-file: 2018-06-01/DataFlowDebugSession_QueryByFactory.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/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/datafactory/armdatafactory/v11"
)

// Generated from example definition: 2018-06-01/DataFlowDebugSession_QueryByFactory.json
func ExampleDataFlowDebugSessionClient_NewQueryByFactoryPager() {
	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)
	}
	pager := clientFactory.NewDataFlowDebugSessionClient().NewQueryByFactoryPager("exampleResourceGroup", "exampleFactoryName", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page = armdatafactory.DataFlowDebugSessionClientQueryByFactoryResponse{
		// 	QueryDataFlowDebugSessionsResponse: armdatafactory.QueryDataFlowDebugSessionsResponse{
		// 		Value: []*armdatafactory.DataFlowDebugSessionInfo{
		// 			{
		// 				ComputeType: to.Ptr("General"),
		// 				CoreCount: to.Ptr[int32](48),
		// 				LastActivityTime: to.Ptr("2019-09-05T18:28:00.9459674+00:00"),
		// 				SessionID: to.Ptr("229c688c-944c-44ac-b31a-82d50f347154"),
		// 				StartTime: to.Ptr("2019-09-05T18:23:20.3257799+00:00"),
		// 				TimeToLiveInMinutes: to.Ptr[int32](60),
		// 				AdditionalProperties: map[string]any{
		// 				"dataflowName": "DebugSession-0a7e0d6e-f2b7-48cc-8cd8-618326f5662f",
		// 				"userObjectId": "0a7e0d6e-f2b7-48cc-8cd8-618326f5662f",
		// 			},
		// 			},
		// 		},
		// 	},
		// }
	}
}

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_QueryByFactory.json
// this example is just showing the usage of "DataFlowDebugSession_QueryByFactory" 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 and iterate over the result
await foreach (DataFlowDebugSessionInfo item in dataFactory.GetDataFlowDebugSessionsAsync())
{
    Console.WriteLine($"Succeeded: {item}");
}

Console.WriteLine("Succeeded");

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

Date: Sat, 16 Jun 2018 00:40:01 GMT
X-Content-Type-Options: nosniff
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

{
  "value": [
    {
      "computeType": "General",
      "coreCount": 48,
      "dataflowName": "DebugSession-0a7e0d6e-f2b7-48cc-8cd8-618326f5662f",
      "lastActivityTime": "2019-09-05T18:28:00.9459674+00:00",
      "sessionId": "229c688c-944c-44ac-b31a-82d50f347154",
      "startTime": "2019-09-05T18:23:20.3257799+00:00",
      "timeToLiveInMinutes": 60,
      "userObjectId": "0a7e0d6e-f2b7-48cc-8cd8-618326f5662f"
    }
  ]
}

Definitions

Name	Description
CloudError	The object that defines the structure of an Azure Data Factory error response.
DataFlowDebugSessionInfo	Data flow debug session info.
QueryDataFlowDebugSessionsResponse	Paged collection of DataFlowDebugSessionInfo items

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.

DataFlowDebugSessionInfo

Object

Data flow debug session info.

Name	Type	Description
computeType	string	Compute type of the cluster.
coreCount	integer (int32)	Core count of the cluster.
dataFlowName	string	The name of the data flow.
integrationRuntimeName	string	Attached integration runtime name of data flow debug session.
lastActivityTime	string	Last activity time of data flow debug session.
nodeCount	integer (int32)	Node count of the cluster. (deprecated property)
sessionId	string	The ID of data flow debug session.
startTime	string	Start time of data flow debug session.
timeToLiveInMinutes	integer (int32)	Compute type of the cluster.

QueryDataFlowDebugSessionsResponse

Object

Paged collection of DataFlowDebugSessionInfo items

Name	Type	Description
nextLink	string (uri)	The link to the next page of items
value	DataFlowDebugSessionInfo[]	The DataFlowDebugSessionInfo items on this page