Clusters - List Streaming Jobs

Service:

Stream Analytics

API Version:

2020-03-01

Listas todos los trabajos de streaming del clúster especificado.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StreamAnalytics/clusters/{clusterName}/listStreamingJobs?api-version=2020-03-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
clusterName	path	True	string	Nombre del clúster.
resourceGroupName	path	True	string	Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas. Regex pattern: ^[-\w\._\(\)]+$
subscriptionId	path	True	string	Identificador de la suscripción de destino.
api-version	query	True	string	Versión de API que se usará para la operación.

Respuestas

Nombre	Tipo	Description
200 OK	ClusterJobListResult	Se muestran correctamente los trabajos de streaming en el clúster especificado.
Other Status Codes	Error	Error.

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory

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

Scopes

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

List all streaming jobs in cluster

Sample Request

HTTP

POST https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/clusters/testcluster/listStreamingJobs?api-version=2020-03-01

Java

import com.azure.core.util.Context;

/** Samples for Clusters ListStreamingJobs. */
public final class Main {
    /*
     * x-ms-original-file: specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Cluster_ListStreamingJobs.json
     */
    /**
     * Sample code: List all streaming jobs in cluster.
     *
     * @param manager Entry point to StreamAnalyticsManager.
     */
    public static void listAllStreamingJobsInCluster(
        com.azure.resourcemanager.streamanalytics.StreamAnalyticsManager manager) {
        manager.clusters().listStreamingJobs("sjrg", "testcluster", 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

Go

package armstreamanalytics_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/streamanalytics/armstreamanalytics"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Cluster_ListStreamingJobs.json
func ExampleClustersClient_NewListStreamingJobsPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armstreamanalytics.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewClustersClient().NewListStreamingJobsPager("sjrg", "testcluster", 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.ClusterJobListResult = armstreamanalytics.ClusterJobListResult{
		// 	Value: []*armstreamanalytics.ClusterJob{
		// 		{
		// 			ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/sjrg/providers/microsoft.streamAnalytics/streamingjobs/AFilterSample"),
		// 			JobState: to.Ptr(armstreamanalytics.JobStateRunning),
		// 			StreamingUnits: to.Ptr[int32](6),
		// 		},
		// 		{
		// 			ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/sjrg/providers/microsoft.streamAnalytics/streamingjobs/AnotherFilterSample"),
		// 			JobState: to.Ptr(armstreamanalytics.JobStateStopped),
		// 			StreamingUnits: to.Ptr[int32](1),
		// 	}},
		// }
	}
}

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 { StreamAnalyticsManagementClient } = require("@azure/arm-streamanalytics");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Lists all of the streaming jobs in the given cluster.
 *
 * @summary Lists all of the streaming jobs in the given cluster.
 * x-ms-original-file: specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Cluster_ListStreamingJobs.json
 */
async function listAllStreamingJobsInCluster() {
  const subscriptionId = "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
  const resourceGroupName = "sjrg";
  const clusterName = "testcluster";
  const credential = new DefaultAzureCredential();
  const client = new StreamAnalyticsManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.clusters.listStreamingJobs(resourceGroupName, clusterName)) {
    resArray.push(item);
  }
  console.log(resArray);
}

listAllStreamingJobsInCluster().catch(console.error);

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

{
  "value": [
    {
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/sjrg/providers/microsoft.streamAnalytics/streamingjobs/AFilterSample",
      "streamingUnits": 6,
      "jobState": "Running"
    },
    {
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/sjrg/providers/microsoft.streamAnalytics/streamingjobs/AnotherFilterSample",
      "streamingUnits": 1,
      "jobState": "Stopped"
    }
  ],
  "nextLink": null
}

Definiciones

Nombre	Description
ClusterJob	Un trabajo de streaming.
ClusterJobListResult	Lista de trabajos de streaming. Rellenado por una operación List.
Error	Representación de error común.
JobState	Estado de ejecución actual del trabajo de streaming.

ClusterJob

Un trabajo de streaming.

Nombre	Tipo	Description
id	string	Identificador de recurso del trabajo de streaming.
jobState	JobState	Estado de ejecución actual del trabajo de streaming.
streamingUnits	integer	Número de unidades de streaming que usa el trabajo de streaming.

ClusterJobListResult

Lista de trabajos de streaming. Rellenado por una operación List.

Nombre	Tipo	Description
nextLink	string	Dirección URL para capturar el siguiente conjunto de trabajos de streaming.
value	ClusterJob[]	Lista de trabajos de streaming.

Error

Representación de error común.

Nombre	Tipo	Description
error	Error	Propiedades de definición de error.

JobState

Estado de ejecución actual del trabajo de streaming.

Nombre	Tipo	Description
Created	string	El trabajo está actualmente en estado Creado.
Degraded	string	El trabajo está actualmente en estado Degradado.
Deleting	string	El trabajo se encuentra actualmente en estado de eliminación.
Failed	string	El trabajo está actualmente en estado De error.
Restarting	string	El trabajo está actualmente en estado de reinicio.
Running	string	El trabajo está actualmente en estado En ejecución.
Scaling	string	El trabajo está actualmente en estado Escalado.
Starting	string	El trabajo se encuentra actualmente en el estado Starting.
Stopped	string	El trabajo está actualmente en estado Detenido.
Stopping	string	El trabajo está actualmente en estado de detención.