Clusters - List Streaming Jobs

Service:

Stream Analytics

API Version:

2020-03-01

Elenchi tutti i processi di streaming nel cluster specificato.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
clusterName	path	True	string	Nome del cluster.
resourceGroupName	path	True	string	Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole. Regex pattern: ^[-\w\._\(\)]+$
subscriptionId	path	True	string	ID della sottoscrizione di destinazione.
api-version	query	True	string	Versione dell'API da usare per questa operazione.

Risposte

Nome	Tipo	Descrizione
200 OK	ClusterJobListResult	Sono stati elencati correttamente i processi di streaming nel cluster specificato.
Other Status Codes	Error	Errore.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

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

Scopes

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

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
}

Definizioni

Nome	Descrizione
ClusterJob	Un processo di streaming.
ClusterJobListResult	Elenco dei processi di streaming. Popolato da un'operazione Elenco.
Error	Rappresentazione di errore comune.
JobState	Stato di esecuzione corrente del processo di streaming.

ClusterJob

Un processo di streaming.

Nome	Tipo	Descrizione
id	string	ID risorsa del processo di streaming.
jobState	JobState	Stato di esecuzione corrente del processo di streaming.
streamingUnits	integer	Numero di unità di streaming usate dal processo di streaming.

ClusterJobListResult

Elenco dei processi di streaming. Popolato da un'operazione Elenco.

Nome	Tipo	Descrizione
nextLink	string	URL per recuperare il set successivo di processi di streaming.
value	ClusterJob[]	Elenco dei processi di streaming.

Error

Rappresentazione di errore comune.

Nome	Tipo	Descrizione
error	Error	Proprietà di definizione degli errori.

JobState

Stato di esecuzione corrente del processo di streaming.

Nome	Tipo	Descrizione
Created	string	Il processo è attualmente nello stato Creato.
Degraded	string	Il processo è attualmente in stato degradato.
Deleting	string	Il processo è attualmente in stato Eliminazione.
Failed	string	Il processo è attualmente in stato Non riuscito.
Restarting	string	Il processo è attualmente in stato di riavvio.
Running	string	Il processo è attualmente in esecuzione.
Scaling	string	Il processo è attualmente nello stato Ridimensionamento.
Starting	string	Il processo è attualmente nello stato iniziale.
Stopped	string	Il processo è attualmente in stato Arrestato.
Stopping	string	Il processo è attualmente in stato di arresto.