Clusters - List Streaming Jobs

Service:

Stream Analytics

API Version:

2020-03-01

Listen alle Streamingaufträge im angegebenen Cluster.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
clusterName	path	True	string	Der Name des Clusters.
resourceGroupName	path	True	string	Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet. Regex pattern: ^[-\w\._\(\)]+$
subscriptionId	path	True	string	Hierbei handelt es sich um die ID des Zielabonnements.
api-version	query	True	string	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Antworten

Name	Typ	Beschreibung
200 OK	ClusterJobListResult	Die Streamingaufträge im angegebenen Cluster wurden erfolgreich aufgelistet.
Other Status Codes	Error	Fehler.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

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

Scopes

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

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
}

Definitionen

Name	Beschreibung
ClusterJob	Ein Streamingauftrag.
ClusterJobListResult	Eine Liste mit Streamingaufträgen. Wird durch einen Listenvorgang aufgefüllt.
Error	Häufige Fehlerdarstellung.
JobState	Der aktuelle Ausführungsstatus des Streamingauftrags.

ClusterJob

Ein Streamingauftrag.

Name	Typ	Beschreibung
id	string	Ressourcen-ID des Streamingauftrags.
jobState	JobState	Der aktuelle Ausführungsstatus des Streamingauftrags.
streamingUnits	integer	Die Anzahl der Streamingeinheiten, die vom Streamingauftrag verwendet werden.

ClusterJobListResult

Eine Liste mit Streamingaufträgen. Wird durch einen Listenvorgang aufgefüllt.

Name	Typ	Beschreibung
nextLink	string	Die URL zum Abrufen des nächsten Satzes von Streamingaufträgen.
value	ClusterJob[]	Eine Liste mit Streamingaufträgen.

Error

Häufige Fehlerdarstellung.

Name	Typ	Beschreibung
error	Error	Fehlerdefinitionseigenschaften.

JobState

Der aktuelle Ausführungsstatus des Streamingauftrags.

Name	Typ	Beschreibung
Created	string	Der Auftrag befindet sich derzeit im Status Erstellt.
Degraded	string	Der Auftrag befindet sich derzeit im Status "Herabgestuft".
Deleting	string	Der Auftrag befindet sich derzeit im Status Löschen.
Failed	string	Der Auftrag befindet sich derzeit im Status Fehler.
Restarting	string	Der Auftrag befindet sich derzeit im Status Neustarten.
Running	string	Der Auftrag befindet sich derzeit im Status "Ausgeführt".
Scaling	string	Der Auftrag befindet sich derzeit im Skalierungszustand.
Starting	string	Der Auftrag befindet sich derzeit im Status "Start".
Stopped	string	Der Auftrag befindet sich derzeit im Status Beendet.
Stopping	string	Der Auftrag befindet sich derzeit im Status "Beenden".