Data Flow Debug Session - Query By Factory

Szolgáltatás:

Data Factory

API-verzió:

2018-06-01

Az összes aktív adatfolyam-hibakeresési munkamenet lekérdezése.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
factoryName	path	True	string minLength: 3 maxLength: 63 pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$	A gyár neve.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+$	Az erőforráscsoport neve.
subscriptionId	path	True	string	Az előfizetés azonosítója.
api-version	query	True	string	Az API-verzió.

Válaszok

Name	Típus	Description
200 OK	QueryDataFlowDebugSessionsResponse	OKÉ.
Other Status Codes	CloudError	Az Azure Data Factory szolgáltatástól kapott hibaválasz.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow.

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	a felhasználói fiók megszemélyesítése

Példák

DataFlowDebugSession_QueryByFactory

Mintakérelem

HTTP

POST https://management.azure.com/subscriptions/12345678-1234-1234-1234-12345678abc/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: specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/
     * 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="12345678-1234-1234-1234-12345678abc",
    )

    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: specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/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/v10"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/8eb3f7a4f66d408152c32b9d647e59147172d533/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/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("<subscription-id>", 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.QueryDataFlowDebugSessionsResponse = armdatafactory.QueryDataFlowDebugSessionsResponse{
		// 	Value: []*armdatafactory.DataFlowDebugSessionInfo{
		// 		{
		// 			AdditionalProperties: map[string]any{
		// 				"dataflowName": "DebugSession-0a7e0d6e-f2b7-48cc-8cd8-618326f5662f",
		// 				"userObjectId": "0a7e0d6e-f2b7-48cc-8cd8-618326f5662f",
		// 			},
		// 			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),
		// 	}},
		// }
	}
}

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 Query all active data flow debug sessions.
 *
 * @summary Query all active data flow debug sessions.
 * x-ms-original-file: specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/DataFlowDebugSession_QueryByFactory.json
 */
async function dataFlowDebugSessionQueryByFactory() {
  const subscriptionId =
    process.env["DATAFACTORY_SUBSCRIPTION_ID"] || "12345678-1234-1234-1234-12345678abc";
  const resourceGroupName = process.env["DATAFACTORY_RESOURCE_GROUP"] || "exampleResourceGroup";
  const factoryName = "exampleFactoryName";
  const credential = new DefaultAzureCredential();
  const client = new DataFactoryManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.dataFlowDebugSession.listQueryByFactory(
    resourceGroupName,
    factoryName,
  )) {
    resArray.push(item);
  }
  console.log(resArray);
}

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.Core.Expressions.DataFactory;
using Azure.Identity;
using Azure.ResourceManager.DataFactory.Models;
using Azure.ResourceManager.DataFactory;

// Generated from example definition: specification/datafactory/resource-manager/Microsoft.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

Mintaválasz

Állapotkód:

200

Date: Sat, 16 Jun 2018 00:40:01 GMT
X-Content-Type-Options: nosniff
x-ms-ratelimit-remaining-subscription-reads: 14989
x-ms-request-id: 2f955e10-c6df-45a7-97d4-81acdb8540cd
x-ms-correlation-request-id: 2f955e10-c6df-45a7-97d4-81acdb8540cd

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

Definíciók

Name	Description
CloudError	Az Azure Data Factory hibaválasz szerkezetét meghatározó objektum.
DataFlowDebugSessionInfo	Adatfolyam-hibakeresési munkamenet adatai.
QueryDataFlowDebugSessionsResponse	Az aktív hibakeresési munkamenetek listája.

CloudError

Objektum

Az Azure Data Factory hibaválasz szerkezetét meghatározó objektum.

Name	Típus	Description
error.code	string	Hibakód.
error.details	CloudError[]	Tömb további hibaadatokkal.
error.message	string	Hibaüzenet.
error.target	string	A kérelemben szereplő tulajdonság neve/elérési útja hibával van társítva.

DataFlowDebugSessionInfo

Objektum

Adatfolyam-hibakeresési munkamenet adatai.

Name	Típus	Description
computeType	string	A fürt számítási típusa.
coreCount	integer	A fürt alapszáma.
dataFlowName	string	Az adatfolyam neve.
integrationRuntimeName	string	Az adatfolyam-hibakeresési munkamenet csatolt integrációs moduljának neve.
lastActivityTime	string	Az adatfolyam-hibakeresési munkamenet utolsó tevékenységideje.
nodeCount	integer	A fürt csomópontszáma. (elavult tulajdonság)
sessionId	string	Az adatfolyam-hibakeresési munkamenet azonosítója.
startTime	string	Az adatfolyam-hibakeresési munkamenet kezdési időpontja.
timeToLiveInMinutes	integer	A fürt számítási típusa.

QueryDataFlowDebugSessionsResponse

Objektum

Az aktív hibakeresési munkamenetek listája.

Name	Típus	Description
nextLink	string	Az eredmények következő oldalára mutató hivatkozás, ha vannak még találatok.
value	DataFlowDebugSessionInfo[]	Tömb az összes aktív hibakeresési munkamenettel.